\n from fastapi import FastAPI, File, Form, UploadFile\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:23: in <module>\n from fastapi._compat import (\nE ImportError: cannot import name 'get_model_fields' from 'fastapi._compat' (/workspace/test_repo/fastapi/_compat.py)\n=========================== short test summary info ============================\nERROR tests/test_multipart_installation.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.63s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 10, 'passed': 10, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/dependencies/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_multipart_installation.py"}}},{"rowIdx":44,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__is_gen_callable__b90bf2da9ee5870a45591a10c4c8ac4af76d12f1"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b90bf2da9ee5870a45591a10c4c8ac4af76d12f1"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"is_gen_callable"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def is_gen_callable(call: Callable) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n call = getattr(call, \"__call__\", None)\n return inspect.isgeneratorfunction(call)\n"},"gold_code":{"kind":"string","value":"def is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom contextlib import contextmanager\nfrom copy import deepcopy\nfrom typing import (\n Any,\n Callable,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nfrom fastapi import params\nfrom fastapi.concurrency import (\n AsyncExitStack,\n _fake_asynccontextmanager,\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import (\n PYDANTIC_1,\n create_response_field,\n get_field_info,\n get_path_param_names,\n)\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.error_wrappers import ErrorWrapper\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.background import BackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import FormData, Headers, QueryParams, UploadFile\nfrom starlette.requests import Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\n\ntry:\n from pydantic.fields import (\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n FieldInfo,\n ModelField,\n Required,\n )\n from pydantic.schema import get_annotation_from_field_info\n from pydantic.typing import ForwardRef, evaluate_forwardref\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic.fields import Required, Shape # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n from pydantic.schema import get_annotation_from_schema # type: ignore\n from pydantic.utils import ForwardRef, evaluate_forwardref # type: ignore\n\n SHAPE_LIST = Shape.LIST\n SHAPE_SEQUENCE = Shape.SEQUENCE\n SHAPE_SET = Shape.SET\n SHAPE_SINGLETON = Shape.SINGLETON\n SHAPE_TUPLE = Shape.TUPLE\n SHAPE_TUPLE_ELLIPSIS = Shape.TUPLE_ELLIPS\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Type[Any]:\n return get_annotation_from_schema(annotation, field_info)\n\n\nsequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n}\nsequence_types = (list, set, tuple)\nsequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n}\n\n\ndef get_param_sub_dependant(\n *, param: inspect.Parameter, path: str, security_scopes: List[str] = None\n) -> Dependant:\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n return get_sub_dependant(\n depends=depends,\n dependency=dependency,\n path=path,\n name=param.name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable,\n path: str,\n name: str = None,\n security_scopes: List[str] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n sub_dependant.security_scopes = security_scopes\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant, *, skip_repeats: bool = False, visited: List[CacheKey] = None\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef is_scalar_field(field: ModelField) -> bool:\n field_info = get_field_info(field)\n if not (\n field.shape == SHAPE_SINGLETON\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, sequence_types + (dict,))\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields:\n if not all(is_scalar_field(f) for f in field.sub_fields):\n return False\n return True\n\n\ndef is_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass(\n field.type_, BaseModel\n ):\n if field.sub_fields is not None:\n for sub_field in field.sub_fields:\n if not is_scalar_field(sub_field):\n return False\n return True\n if lenient_issubclass(field.type_, sequence_types):\n return True\n return False\n\n\ndef get_typed_signature(call: Callable) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(param: inspect.Parameter, globalns: Dict[str, Any]) -> Any:\n annotation = param.annotation\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\nasync_contextmanager_dependencies_error = \"\"\"\nFastAPI dependencies with yield require Python 3.7 or above,\nor the backports for Python 3.6, installed with:\n pip install async-exit-stack async-generator\n\"\"\"\n\n\ndef check_dependency_contextmanagers() -> None:\n if AsyncExitStack is None or asynccontextmanager == _fake_asynccontextmanager:\n raise RuntimeError(\n async_contextmanager_dependencies_error) # pragma: no cover\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable,\n name: str = None,\n security_scopes: List[str] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n if is_gen_callable(call) or is_async_gen_callable(call):\n check_dependency_contextmanagers()\n dependant = Dependant(call=call, name=name, path=path, use_cache=use_cache)\n for param_name, param in signature_params.items():\n if isinstance(param.default, params.Depends):\n sub_dependant = get_param_sub_dependant(\n param=param, path=path, security_scopes=security_scopes\n )\n dependant.dependencies.append(sub_dependant)\n for param_name, param in signature_params.items():\n if isinstance(param.default, params.Depends):\n continue\n if add_non_field_param_to_dependency(param=param, dependant=dependant):\n continue\n param_field = get_param_field(\n param=param, default_field_info=params.Query, param_name=param_name\n )\n if param_name in path_param_names:\n assert is_scalar_field(\n field=param_field\n ), f\"Path params must be of one of the supported types\"\n if isinstance(param.default, params.Path):\n ignore_default = False\n else:\n ignore_default = True\n param_field = get_param_field(\n param=param,\n param_name=param_name,\n default_field_info=params.Path,\n force_type=params.ParamTypes.path,\n ignore_default=ignore_default,\n )\n add_param_to_fields(field=param_field, dependant=dependant)\n elif is_scalar_field(field=param_field):\n add_param_to_fields(field=param_field, dependant=dependant)\n elif isinstance(\n param.default, (params.Query, params.Header)\n ) and is_scalar_sequence_field(param_field):\n add_param_to_fields(field=param_field, dependant=dependant)\n else:\n field_info = get_field_info(param_field)\n assert isinstance(\n field_info, params.Body\n ), f\"Param: {param_field.name} can only be a request body, using Body(...)\"\n dependant.body_params.append(param_field)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param: inspect.Parameter, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param.name\n return True\n elif lenient_issubclass(param.annotation, WebSocket):\n dependant.websocket_param_name = param.name\n return True\n elif lenient_issubclass(param.annotation, Response):\n dependant.response_param_name = param.name\n return True\n elif lenient_issubclass(param.annotation, BackgroundTasks):\n dependant.background_tasks_param_name = param.name\n return True\n elif lenient_issubclass(param.annotation, SecurityScopes):\n dependant.security_scopes_param_name = param.name\n return True\n return None\n\n\ndef get_param_field(\n *,\n param: inspect.Parameter,\n param_name: str,\n default_field_info: Type[params.Param] = params.Param,\n force_type: params.ParamTypes = None,\n ignore_default: bool = False,\n) -> ModelField:\n default_value = Required\n had_schema = False\n if not param.default == param.empty and ignore_default is False:\n default_value = param.default\n if isinstance(default_value, FieldInfo):\n had_schema = True\n field_info = default_value\n default_value = field_info.default\n if (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = default_field_info.in_\n if force_type:\n field_info.in_ = force_type # type: ignore\n else:\n field_info = default_field_info(default_value)\n required = default_value == Required\n annotation: Any = Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_field_info(\n annotation, field_info, param_name)\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param.name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param.name\n field = create_response_field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=alias,\n required=required,\n field_info=field_info,\n )\n field.required = required\n if not had_schema and not is_scalar_field(field=field):\n if PYDANTIC_1:\n field.field_info = params.Body(field_info.default)\n else:\n # type: ignore # pragma: nocover\n field.schema = params.Body(field_info.default)\n\n return field\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = cast(params.Param, get_field_info(field))\n if field_info.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n call = getattr(call, \"__call__\", None)\n return inspect.iscoroutinefunction(call)\n\n\ndef is_async_gen_callable(call: Callable) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n call = getattr(call, \"__call__\", None)\n return inspect.isasyncgenfunction(call)\n\n\ndef request_params_to_args(\n required_params: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n if is_scalar_sequence_field(field) and isinstance(\n received_params, (QueryParams, Headers)\n ):\n value = received_params.getlist(field.alias) or field.default\n else:\n value = received_params.get(field.alias)\n field_info = get_field_info(field)\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n if value is None:\n if field.required:\n if PYDANTIC_1:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(field_info.in_.value, field.alias)\n )\n )\n else: # pragma: nocover\n errors.append(\n ErrorWrapper( # type: ignore\n MissingError(),\n loc=(field_info.in_.value, field.alias),\n config=BaseConfig,\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field_info.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\nasync def request_body_to_args(\n required_params: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n field_info = get_field_info(field)\n embed = getattr(field_info, \"embed\", None)\n if len(required_params) == 1 and not embed:\n received_body = {field.alias: received_body}\n for field in required_params:\n value: Any = None\n if received_body is not None:\n if (\n field.shape in sequence_shapes or field.type_ in sequence_types\n ) and isinstance(received_body, FormData):\n value = received_body.getlist(field.alias)\n else:\n try:\n value = received_body.get(field.alias)\n except AttributeError:\n errors.append(get_missing_field_error(field.alias))\n continue\n if (\n value is None\n or (isinstance(field_info, params.Form) and value == \"\")\n or (\n isinstance(field_info, params.Form)\n and field.shape in sequence_shapes\n and len(value) == 0\n )\n ):\n if field.required:\n errors.append(get_missing_field_error(field.alias))\n else:\n values[field.name] = deepcopy(field.default)\n continue\n if (\n isinstance(field_info, params.File)\n and lenient_issubclass(field.type_, bytes)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n field.shape in sequence_shapes\n and isinstance(field_info, params.File)\n and lenient_issubclass(field.type_, bytes)\n and isinstance(value, sequence_types)\n ):\n awaitables = [sub_value.read() for sub_value in value]\n contents = await asyncio.gather(*awaitables)\n value = sequence_shape_to_type[field.shape](contents)\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_missing_field_error(field_alias: str) -> ErrorWrapper:\n if PYDANTIC_1:\n missing_field_error = ErrorWrapper(\n MissingError(), loc=(\"body\", field_alias))\n else: # pragma: no cover\n missing_field_error = ErrorWrapper( # type: ignore\n MissingError(), loc=(\"body\", field_alias), config=BaseConfig,\n )\n return missing_field_error\n\n\ndef get_schema_compatible_field(*, field: ModelField) -> ModelField:\n out_field = field\n if lenient_issubclass(field.type_, UploadFile):\n use_type: type = bytes\n if field.shape in sequence_shapes:\n use_type = List[bytes]\n out_field = create_response_field(\n name=field.name,\n type_=use_type,\n class_validators=field.class_validators,\n model_config=field.model_config,\n default=field.default,\n required=field.required,\n alias=field.alias,\n field_info=field.field_info if PYDANTIC_1 else field.schema, # type: ignore\n )\n\n return out_field\n\n\ndef get_body_field(*, dependant: Dependant, name: str) -> Optional[ModelField]:\n flat_dependant = get_flat_dependant(dependant)\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n field_info = get_field_info(first_param)\n embed = getattr(field_info, \"embed\", None)\n body_param_names_set = set(\n [param.name for param in flat_dependant.body_params])\n if len(body_param_names_set) == 1 and not embed:\n return get_schema_compatible_field(field=first_param)\n # If one field requires to embed, all have to be embedded\n # in case a sub-dependency is evaluated with a single unique body field\n # That is combined (embedded) with other body fields\n for param in flat_dependant.body_params:\n setattr(get_field_info(param), \"embed\", True)\n model_name = \"Body_\" + name\n BodyModel = create_model(model_name)\n for f in flat_dependant.body_params:\n BodyModel.__fields__[f.name] = get_schema_compatible_field(field=f)\n required = any(True for f in flat_dependant.body_params if f.required)\n\n BodyFieldInfo_kwargs: Dict[str, Any] = dict(default=None)\n if any(\n isinstance(get_field_info(f), params.File) for f in flat_dependant.body_params\n ):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(\n isinstance(get_field_info(f), params.Form) for f in flat_dependant.body_params\n ):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n getattr(get_field_info(f), \"media_type\")\n for f in flat_dependant.body_params\n if isinstance(get_field_info(f), params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n return create_response_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom contextlib import contextmanager\nfrom copy import deepcopy\nfrom typing import (\n Any,\n Callable,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nfrom fastapi import params\nfrom fastapi.concurrency import (\n AsyncExitStack,\n _fake_asynccontextmanager,\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import (\n PYDANTIC_1,\n create_response_field,\n get_field_info,\n get_path_param_names,\n)\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.error_wrappers import ErrorWrapper\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.background import BackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import FormData, Headers, QueryParams, UploadFile\nfrom starlette.requests import Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\n\ntry:\n from pydantic.fields import (\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n FieldInfo,\n ModelField,\n Required,\n )\n from pydantic.schema import get_annotation_from_field_info\n from pydantic.typing import ForwardRef, evaluate_forwardref\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic.fields import Required, Shape # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n from pydantic.schema import get_annotation_from_schema # type: ignore\n from pydantic.utils import ForwardRef, evaluate_forwardref # type: ignore\n\n SHAPE_LIST = Shape.LIST\n SHAPE_SEQUENCE = Shape.SEQUENCE\n SHAPE_SET = Shape.SET\n SHAPE_SINGLETON = Shape.SINGLETON\n SHAPE_TUPLE = Shape.TUPLE\n SHAPE_TUPLE_ELLIPSIS = Shape.TUPLE_ELLIPS\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Type[Any]:\n return get_annotation_from_schema(annotation, field_info)\n\n\nsequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n}\nsequence_types = (list, set, tuple)\nsequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n}\n\n\ndef get_param_sub_dependant(\n *, param: inspect.Parameter, path: str, security_scopes: List[str] = None\n) -> Dependant:\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n return get_sub_dependant(\n depends=depends,\n dependency=dependency,\n path=path,\n name=param.name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable,\n path: str,\n name: str = None,\n security_scopes: List[str] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n sub_dependant.security_scopes = security_scopes\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant, *, skip_repeats: bool = False, visited: List[CacheKey] = None\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef is_scalar_field(field: ModelField) -> bool:\n field_info = get_field_info(field)\n if not (\n field.shape == SHAPE_SINGLETON\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, sequence_types + (dict,))\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields:\n if not all(is_scalar_field(f) for f in field.sub_fields):\n return False\n return True\n\n\ndef is_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass(\n field.type_, BaseModel\n ):\n if field.sub_fields is not None:\n for sub_field in field.sub_fields:\n if not is_scalar_field(sub_field):\n return False\n return True\n if lenient_issubclass(field.type_, sequence_types):\n return True\n return False\n\n\ndef get_typed_signature(call: Callable) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(param: inspect.Parameter, globalns: Dict[str, Any]) -> Any:\n annotation = param.annotation\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\nasync_contextmanager_dependencies_error = \"\"\"\nFastAPI dependencies with yield require Python 3.7 or above,\nor the backports for Python 3.6, installed with:\n pip install async-exit-stack async-generator\n\"\"\"\n\n\ndef check_dependency_contextmanagers() -> None:\n if AsyncExitStack is None or asynccontextmanager == _fake_asynccontextmanager:\n raise RuntimeError(\n async_contextmanager_dependencies_error) # pragma: no cover\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable,\n name: str = None,\n security_scopes: List[str] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n if is_gen_callable(call) or is_async_gen_callable(call):\n check_dependency_contextmanagers()\n dependant = Dependant(call=call, name=name, path=path, use_cache=use_cache)\n for param_name, param in signature_params.items():\n if isinstance(param.default, params.Depends):\n sub_dependant = get_param_sub_dependant(\n param=param, path=path, security_scopes=security_scopes\n )\n dependant.dependencies.append(sub_dependant)\n for param_name, param in signature_params.items():\n if isinstance(param.default, params.Depends):\n continue\n if add_non_field_param_to_dependency(param=param, dependant=dependant):\n continue\n param_field = get_param_field(\n param=param, default_field_info=params.Query, param_name=param_name\n )\n if param_name in path_param_names:\n assert is_scalar_field(\n field=param_field\n ), f\"Path params must be of one of the supported types\"\n if isinstance(param.default, params.Path):\n ignore_default = False\n else:\n ignore_default = True\n param_field = get_param_field(\n param=param,\n param_name=param_name,\n default_field_info=params.Path,\n force_type=params.ParamTypes.path,\n ignore_default=ignore_default,\n )\n add_param_to_fields(field=param_field, dependant=dependant)\n elif is_scalar_field(field=param_field):\n add_param_to_fields(field=param_field, dependant=dependant)\n elif isinstance(\n param.default, (params.Query, params.Header)\n ) and is_scalar_sequence_field(param_field):\n add_param_to_fields(field=param_field, dependant=dependant)\n else:\n field_info = get_field_info(param_field)\n assert isinstance(\n field_info, params.Body\n ), f\"Param: {param_field.name} can only be a request body, using Body(...)\"\n dependant.body_params.append(param_field)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param: inspect.Parameter, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param.name\n return True\n elif lenient_issubclass(param.annotation, WebSocket):\n dependant.websocket_param_name = param.name\n return True\n elif lenient_issubclass(param.annotation, Response):\n dependant.response_param_name = param.name\n return True\n elif lenient_issubclass(param.annotation, BackgroundTasks):\n dependant.background_tasks_param_name = param.name\n return True\n elif lenient_issubclass(param.annotation, SecurityScopes):\n dependant.security_scopes_param_name = param.name\n return True\n return None\n\n\ndef get_param_field(\n *,\n param: inspect.Parameter,\n param_name: str,\n default_field_info: Type[params.Param] = params.Param,\n force_type: params.ParamTypes = None,\n ignore_default: bool = False,\n) -> ModelField:\n default_value = Required\n had_schema = False\n if not param.default == param.empty and ignore_default is False:\n default_value = param.default\n if isinstance(default_value, FieldInfo):\n had_schema = True\n field_info = default_value\n default_value = field_info.default\n if (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = default_field_info.in_\n if force_type:\n field_info.in_ = force_type # type: ignore\n else:\n field_info = default_field_info(default_value)\n required = default_value == Required\n annotation: Any = Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_field_info(\n annotation, field_info, param_name)\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param.name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param.name\n field = create_response_field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=alias,\n required=required,\n field_info=field_info,\n )\n field.required = required\n if not had_schema and not is_scalar_field(field=field):\n if PYDANTIC_1:\n field.field_info = params.Body(field_info.default)\n else:\n # type: ignore # pragma: nocover\n field.schema = params.Body(field_info.default)\n\n return field\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = cast(params.Param, get_field_info(field))\n if field_info.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n call = getattr(call, \"__call__\", None)\n return inspect.iscoroutinefunction(call)\n\n\ndef is_async_gen_callable(call: Callable) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n call = getattr(call, \"__call__\", None)\n return inspect.isasyncgenfunction(call)\n\n\ndef is_gen_callable(call: Callable) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n call = getattr(call, \"__call__\", None)\n return inspect.isgeneratorfunction(call)\n\n\nasync def solve_generator(\n *, call: Callable, stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n if not inspect.isasyncgenfunction(call):\n # asynccontextmanager from the async_generator backfill pre python3.7\n # does not support callables that are not functions or methods.\n # See https://github.com/python-trio/async_generator/issues/32\n #\n # Expand the callable class into its __call__ method before decorating it.\n # This approach will work on newer python versions as well.\n call = getattr(call, \"__call__\", None)\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: BackgroundTasks = None,\n response: Response = None,\n dependency_overrides_provider: Any = None,\n dependency_cache: Dict[Tuple[Callable, Tuple[str]], Any] = None,\n) -> Tuple[\n Dict[str, Any],\n List[ErrorWrapper],\n Optional[BackgroundTasks],\n Response,\n Dict[Tuple[Callable, Tuple[str]], Any],\n]:\n values: Dict[str, Any] = {}\n errors: List[ErrorWrapper] = []\n response = response or Response(\n content=None,\n status_code=None, # type: ignore\n headers=None,\n media_type=None,\n background=None,\n )\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable, sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable, Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n )\n (\n sub_values,\n sub_errors,\n background_tasks,\n sub_response,\n sub_dependency_cache,\n ) = solved_result\n sub_response = cast(Response, sub_response)\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n dependency_cache.update(sub_dependency_cache)\n if sub_errors:\n errors.extend(sub_errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n stack = request.scope.get(\"fastapi_astack\")\n if stack is None:\n raise RuntimeError(\n async_contextmanager_dependencies_error\n ) # pragma: no cover\n solved = await solve_generator(\n call=call, stack=stack, sub_values=sub_values\n )\n elif is_coroutine_callable(call):\n solved = await call(**sub_values)\n else:\n solved = await run_in_threadpool(call, **sub_values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n required_params=dependant.body_params, received_body=body\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return values, errors, background_tasks, response, dependency_cache\n\n\ndef request_params_to_args(\n required_params: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n if is_scalar_sequence_field(field) and isinstance(\n received_params, (QueryParams, Headers)\n ):\n value = received_params.getlist(field.alias) or field.default\n else:\n value = received_params.get(field.alias)\n field_info = get_field_info(field)\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n if value is None:\n if field.required:\n if PYDANTIC_1:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(field_info.in_.value, field.alias)\n )\n )\n else: # pragma: nocover\n errors.append(\n ErrorWrapper( # type: ignore\n MissingError(),\n loc=(field_info.in_.value, field.alias),\n config=BaseConfig,\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field_info.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\nasync def request_body_to_args(\n required_params: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n field_info = get_field_info(field)\n embed = getattr(field_info, \"embed\", None)\n if len(required_params) == 1 and not embed:\n received_body = {field.alias: received_body}\n for field in required_params:\n value: Any = None\n if received_body is not None:\n if (\n field.shape in sequence_shapes or field.type_ in sequence_types\n ) and isinstance(received_body, FormData):\n value = received_body.getlist(field.alias)\n else:\n try:\n value = received_body.get(field.alias)\n except AttributeError:\n errors.append(get_missing_field_error(field.alias))\n continue\n if (\n value is None\n or (isinstance(field_info, params.Form) and value == \"\")\n or (\n isinstance(field_info, params.Form)\n and field.shape in sequence_shapes\n and len(value) == 0\n )\n ):\n if field.required:\n errors.append(get_missing_field_error(field.alias))\n else:\n values[field.name] = deepcopy(field.default)\n continue\n if (\n isinstance(field_info, params.File)\n and lenient_issubclass(field.type_, bytes)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n field.shape in sequence_shapes\n and isinstance(field_info, params.File)\n and lenient_issubclass(field.type_, bytes)\n and isinstance(value, sequence_types)\n ):\n awaitables = [sub_value.read() for sub_value in value]\n contents = await asyncio.gather(*awaitables)\n value = sequence_shape_to_type[field.shape](contents)\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_missing_field_error(field_alias: str) -> ErrorWrapper:\n if PYDANTIC_1:\n missing_field_error = ErrorWrapper(\n MissingError(), loc=(\"body\", field_alias))\n else: # pragma: no cover\n missing_field_error = ErrorWrapper( # type: ignore\n MissingError(), loc=(\"body\", field_alias), config=BaseConfig,\n )\n return missing_field_error\n\n\ndef get_schema_compatible_field(*, field: ModelField) -> ModelField:\n out_field = field\n if lenient_issubclass(field.type_, UploadFile):\n use_type: type = bytes\n if field.shape in sequence_shapes:\n use_type = List[bytes]\n out_field = create_response_field(\n name=field.name,\n type_=use_type,\n class_validators=field.class_validators,\n model_config=field.model_config,\n default=field.default,\n required=field.required,\n alias=field.alias,\n field_info=field.field_info if PYDANTIC_1 else field.schema, # type: ignore\n )\n\n return out_field\n\n\ndef get_body_field(*, dependant: Dependant, name: str) -> Optional[ModelField]:\n flat_dependant = get_flat_dependant(dependant)\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n field_info = get_field_info(first_param)\n embed = getattr(field_info, \"embed\", None)\n body_param_names_set = set(\n [param.name for param in flat_dependant.body_params])\n if len(body_param_names_set) == 1 and not embed:\n return get_schema_compatible_field(field=first_param)\n # If one field requires to embed, all have to be embedded\n # in case a sub-dependency is evaluated with a single unique body field\n # That is combined (embedded) with other body fields\n for param in flat_dependant.body_params:\n setattr(get_field_info(param), \"embed\", True)\n model_name = \"Body_\" + name\n BodyModel = create_model(model_name)\n for f in flat_dependant.body_params:\n BodyModel.__fields__[f.name] = get_schema_compatible_field(field=f)\n required = any(True for f in flat_dependant.body_params if f.required)\n\n BodyFieldInfo_kwargs: Dict[str, Any] = dict(default=None)\n if any(\n isinstance(get_field_info(f), params.File) for f in flat_dependant.body_params\n ):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(\n isinstance(get_field_info(f), params.Form) for f in flat_dependant.body_params\n ):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n getattr(get_field_info(f), \"media_type\")\n for f in flat_dependant.body_params\n if isinstance(get_field_info(f), params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n return create_response_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n"},"new_filtered_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n get_model_fields,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic import BaseModel\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(\n annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(\n annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(\n annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form) and not lenient_issubclass(\n first_field.type_, BaseModel\n ):\n return True\n return False\n\n\nasync def _extract_form_body(\n body_fields: List[ModelField],\n received_body: FormData,\n) -> Dict[str, Any]:\n values = {}\n first_field = body_fields[0]\n first_field_info = first_field.field_info\n\n for field in body_fields:\n value = _get_multidict_value(field, received_body)\n if (\n isinstance(first_field_info, params.File)\n and is_bytes_field(field)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n is_bytes_sequence_field(field)\n and isinstance(first_field_info, params.File)\n and value_is_sequence(value)\n ):\n # For types\n assert isinstance(value, sequence_types) # type: ignore[arg-type]\n results: List[Union[bytes, str]] = []\n\n async def process_fn(\n fn: Callable[[], Coroutine[Any, Any, Any]],\n ) -> None:\n result = await fn()\n results.append(result) # noqa: B023\n\n async with anyio.create_task_group() as tg:\n for sub_value in value:\n tg.start_soon(process_fn, sub_value.read)\n value = serialize_sequence_value(field=field, value=results)\n if value is not None:\n values[field.name] = value\n for key, value in received_body.items():\n if key not in values:\n values[key] = value\n return values\n\n\nasync def request_body_to_args(\n body_fields: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n embed_body_fields: bool,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n values: Dict[str, Any] = {}\n errors: List[Dict[str, Any]] = []\n assert body_fields, \"request_body_to_args() should be called with fields\"\n single_not_embedded_field = len(body_fields) == 1 and not embed_body_fields\n first_field = body_fields[0]\n body_to_process = received_body\n\n fields_to_extract: List[ModelField] = body_fields\n\n if single_not_embedded_field and lenient_issubclass(first_field.type_, BaseModel):\n fields_to_extract = get_model_fields(first_field.type_)\n\n if isinstance(received_body, FormData):\n body_to_process = await _extract_form_body(fields_to_extract, received_body)\n\n if single_not_embedded_field:\n loc: Tuple[str, ...] = (\"body\",)\n v_, errors_ = _validate_value_with_model_field(\n field=first_field, value=body_to_process, values=values, loc=loc\n )\n return {first_field.name: v_}, errors_\n for field in body_fields:\n loc = (\"body\", field.alias)\n value: Optional[Any] = None\n if body_to_process is not None:\n try:\n value = body_to_process.get(field.alias)\n # If the received body is a list, not a dict\n except AttributeError:\n errors.append(get_missing_field_error(loc))\n continue\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"new_complete_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n get_model_fields,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic import BaseModel\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[..., Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form) and not lenient_issubclass(\n first_field.type_, BaseModel\n ):\n return True\n return False\n\n\nasync def _extract_form_body(\n body_fields: List[ModelField],\n received_body: FormData,\n) -> Dict[str, Any]:\n values = {}\n first_field = body_fields[0]\n first_field_info = first_field.field_info\n\n for field in body_fields:\n value = _get_multidict_value(field, received_body)\n if (\n isinstance(first_field_info, params.File)\n and is_bytes_field(field)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n is_bytes_sequence_field(field)\n and isinstance(first_field_info, params.File)\n and value_is_sequence(value)\n ):\n # For types\n assert isinstance(value, sequence_types) # type: ignore[arg-type]\n results: List[Union[bytes, str]] = []\n\n async def process_fn(\n fn: Callable[[], Coroutine[Any, Any, Any]],\n ) -> None:\n result = await fn()\n results.append(result) # noqa: B023\n\n async with anyio.create_task_group() as tg:\n for sub_value in value:\n tg.start_soon(process_fn, sub_value.read)\n value = serialize_sequence_value(field=field, value=results)\n if value is not None:\n values[field.name] = value\n for key, value in received_body.items():\n if key not in values:\n values[key] = value\n return values\n\n\nasync def request_body_to_args(\n body_fields: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n embed_body_fields: bool,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n values: Dict[str, Any] = {}\n errors: List[Dict[str, Any]] = []\n assert body_fields, \"request_body_to_args() should be called with fields\"\n single_not_embedded_field = len(body_fields) == 1 and not embed_body_fields\n first_field = body_fields[0]\n body_to_process = received_body\n\n fields_to_extract: List[ModelField] = body_fields\n\n if single_not_embedded_field and lenient_issubclass(first_field.type_, BaseModel):\n fields_to_extract = get_model_fields(first_field.type_)\n\n if isinstance(received_body, FormData):\n body_to_process = await _extract_form_body(fields_to_extract, received_body)\n\n if single_not_embedded_field:\n loc: Tuple[str, ...] = (\"body\",)\n v_, errors_ = _validate_value_with_model_field(\n field=first_field, value=body_to_process, values=values, loc=loc\n )\n return {first_field.name: v_}, errors_\n for field in body_fields:\n loc = (\"body\", field.alias)\n value: Optional[Any] = None\n if body_to_process is not None:\n try:\n value = body_to_process.get(field.alias)\n # If the received body is a list, not a dict\n except AttributeError:\n errors.append(get_missing_field_error(loc))\n continue\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_multipart_installation.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_multipart_installation.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_multipart_installation.py:2: in <module>\n from fastapi import FastAPI, File, Form, UploadFile\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:23: in <module>\n from fastapi._compat import (\nE ImportError: cannot import name 'get_model_fields' from 'fastapi._compat' (/workspace/test_repo/fastapi/_compat.py)\n=========================== short test summary info ============================\nERROR tests/test_multipart_installation.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.61s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 10, 'passed': 10, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/dependencies/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_multipart_installation.py"}}},{"rowIdx":45,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__request_params_to_args__b9d912c6380661647b51c322820fcb4ba08f32d2"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b9d912c6380661647b51c322820fcb4ba08f32d2"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"request_params_to_args"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def request_params_to_args(\n required_params: List[Field], received_params: Dict[str, Any]\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n"},"gold_code":{"kind":"string","value":"def request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom copy import deepcopy\nfrom typing import Any, Callable, Dict, List, Tuple\n\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.requests import Request\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.utils import get_path_param_names\nfrom pydantic import BaseConfig, Schema, create_model\nfrom pydantic.error_wrappers import ErrorWrapper\nfrom pydantic.errors import MissingError\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic.utils import lenient_issubclass\n\nparam_supported_types = (str, int, float, bool)\n\n\ndef get_sub_dependant(*, param: inspect.Parameter, path: str):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(depends, params.Security) and isinstance(dependency, SecurityBase):\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=depends.scopes\n )\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_requirements.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_dependant(*, path: str, call: Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ) or param.annotation == param.empty, f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig(),\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable = None):\n if not call:\n return False\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(\n *, request: Request, dependant: Dependant, body: Dict[str, Any] = None\n):\n values: Dict[str, Any] = {}\n errors: List[ErrorWrapper] = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant, body=body\n )\n if sub_errors:\n return {}, errors\n if sub_dependant.call and is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[\n sub_dependant.name\n ] = solved # type: ignore # Sub-dependants always have a name\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body_values, body_errors = await request_body_to_args( # type: ignore # body_params checked above\n dependant.body_params, body\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_body_field(*, dependant: Dependant, name: str):\n flat_dependant = get_flat_dependant(dependant)\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n embed = getattr(first_param.schema, \"embed\", None)\n if len(flat_dependant.body_params) == 1 and not embed:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_model(model_name)\n for f in flat_dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(True for f in flat_dependant.body_params if f.required)\n if any(isinstance(f.schema, params.File) for f in flat_dependant.body_params):\n BodySchema = params.File\n elif any(isinstance(f.schema, params.Form) for f in flat_dependant.body_params):\n BodySchema = params.Form\n else:\n BodySchema = params.Body\n\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=BodySchema(None),\n )\n return field\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom copy import deepcopy\nfrom typing import Any, Callable, Dict, List, Tuple\n\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.requests import Request\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.utils import get_path_param_names\nfrom pydantic import BaseConfig, Schema, create_model\nfrom pydantic.error_wrappers import ErrorWrapper\nfrom pydantic.errors import MissingError\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic.utils import lenient_issubclass\n\nparam_supported_types = (str, int, float, bool)\n\n\ndef get_sub_dependant(*, param: inspect.Parameter, path: str):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(depends, params.Security) and isinstance(dependency, SecurityBase):\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=depends.scopes\n )\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_requirements.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_dependant(*, path: str, call: Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ) or param.annotation == param.empty, f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig(),\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable = None):\n if not call:\n return False\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(\n *, request: Request, dependant: Dependant, body: Dict[str, Any] = None\n):\n values: Dict[str, Any] = {}\n errors: List[ErrorWrapper] = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant, body=body\n )\n if sub_errors:\n return {}, errors\n if sub_dependant.call and is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[\n sub_dependant.name\n ] = solved # type: ignore # Sub-dependants always have a name\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body_values, body_errors = await request_body_to_args( # type: ignore # body_params checked above\n dependant.body_params, body\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef request_params_to_args(\n required_params: List[Field], received_params: Dict[str, Any]\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\nasync def request_body_to_args(\n required_params: List[Field], received_body: Dict[str, Any]\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n embed = getattr(field.schema, \"embed\", None)\n if len(required_params) == 1 and not embed:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(*, dependant: Dependant, name: str):\n flat_dependant = get_flat_dependant(dependant)\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n embed = getattr(first_param.schema, \"embed\", None)\n if len(flat_dependant.body_params) == 1 and not embed:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_model(model_name)\n for f in flat_dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(True for f in flat_dependant.body_params if f.required)\n if any(isinstance(f.schema, params.File) for f in flat_dependant.body_params):\n BodySchema = params.File\n elif any(isinstance(f.schema, params.Form) for f in flat_dependant.body_params):\n BodySchema = params.Form\n else:\n BodySchema = params.Body\n\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=BodySchema(None),\n )\n return field\n"},"new_filtered_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n get_model_fields,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic import BaseModel\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(\n annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(\n annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(\n annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[...,\n Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"new_complete_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n get_model_fields,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic import BaseModel\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[..., Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form) and not lenient_issubclass(\n first_field.type_, BaseModel\n ):\n return True\n return False\n\n\nasync def _extract_form_body(\n body_fields: List[ModelField],\n received_body: FormData,\n) -> Dict[str, Any]:\n values = {}\n first_field = body_fields[0]\n first_field_info = first_field.field_info\n\n for field in body_fields:\n value = _get_multidict_value(field, received_body)\n if (\n isinstance(first_field_info, params.File)\n and is_bytes_field(field)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n is_bytes_sequence_field(field)\n and isinstance(first_field_info, params.File)\n and value_is_sequence(value)\n ):\n # For types\n assert isinstance(value, sequence_types) # type: ignore[arg-type]\n results: List[Union[bytes, str]] = []\n\n async def process_fn(\n fn: Callable[[], Coroutine[Any, Any, Any]],\n ) -> None:\n result = await fn()\n results.append(result) # noqa: B023\n\n async with anyio.create_task_group() as tg:\n for sub_value in value:\n tg.start_soon(process_fn, sub_value.read)\n value = serialize_sequence_value(field=field, value=results)\n if value is not None:\n values[field.name] = value\n for key, value in received_body.items():\n if key not in values:\n values[key] = value\n return values\n\n\nasync def request_body_to_args(\n body_fields: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n embed_body_fields: bool,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n values: Dict[str, Any] = {}\n errors: List[Dict[str, Any]] = []\n assert body_fields, \"request_body_to_args() should be called with fields\"\n single_not_embedded_field = len(body_fields) == 1 and not embed_body_fields\n first_field = body_fields[0]\n body_to_process = received_body\n\n fields_to_extract: List[ModelField] = body_fields\n\n if single_not_embedded_field and lenient_issubclass(first_field.type_, BaseModel):\n fields_to_extract = get_model_fields(first_field.type_)\n\n if isinstance(received_body, FormData):\n body_to_process = await _extract_form_body(fields_to_extract, received_body)\n\n if single_not_embedded_field:\n loc: Tuple[str, ...] = (\"body\",)\n v_, errors_ = _validate_value_with_model_field(\n field=first_field, value=body_to_process, values=values, loc=loc\n )\n return {first_field.name: v_}, errors_\n for field in body_fields:\n loc = (\"body\", field.alias)\n value: Optional[Any] = None\n if body_to_process is not None:\n try:\n value = body_to_process.get(field.alias)\n # If the received body is a list, not a dict\n except AttributeError:\n errors.append(get_missing_field_error(loc))\n continue\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_multipart_installation.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_multipart_installation.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_multipart_installation.py:2: in <module>\n from fastapi import FastAPI, File, Form, UploadFile\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:23: in <module>\n from fastapi._compat import (\nE ImportError: cannot import name 'get_model_fields' from 'fastapi._compat' (/workspace/test_repo/fastapi/_compat.py)\n=========================== short test summary info ============================\nERROR tests/test_multipart_installation.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 10, 'passed': 10, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/dependencies/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_multipart_installation.py"}}},{"rowIdx":46,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils___should_embed_body_fields__aa21814a89853c17c139054a5c51f0bb1ea68a0a"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"aa21814a89853c17c139054a5c51f0bb1ea68a0a"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"_should_embed_body_fields"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form):\n return True\n return False\n"},"gold_code":{"kind":"string","value":"def _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form) and not lenient_issubclass(\n first_field.type_, BaseModel\n ):\n return True\n return False\n"},"old_filtered_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(\n annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(\n annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(\n annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[...,\n Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"old_complete_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(\n annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(\n annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(\n annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[...,\n Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form):\n return True\n return False\n\n\nasync def _extract_form_body(\n body_fields: List[ModelField],\n received_body: FormData,\n) -> Dict[str, Any]:\n values = {}\n first_field = body_fields[0]\n first_field_info = first_field.field_info\n\n for field in body_fields:\n value = _get_multidict_value(field, received_body)\n if (\n isinstance(first_field_info, params.File)\n and is_bytes_field(field)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n is_bytes_sequence_field(field)\n and isinstance(first_field_info, params.File)\n and value_is_sequence(value)\n ):\n # For types\n assert isinstance(value, sequence_types) # type: ignore[arg-type]\n results: List[Union[bytes, str]] = []\n\n async def process_fn(\n fn: Callable[[], Coroutine[Any, Any, Any]],\n ) -> None:\n result = await fn()\n results.append(result) # noqa: B023\n\n async with anyio.create_task_group() as tg:\n for sub_value in value:\n tg.start_soon(process_fn, sub_value.read)\n value = serialize_sequence_value(field=field, value=results)\n values[field.name] = value\n return values\n\n\nasync def request_body_to_args(\n body_fields: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n embed_body_fields: bool,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n values: Dict[str, Any] = {}\n errors: List[Dict[str, Any]] = []\n assert body_fields, \"request_body_to_args() should be called with fields\"\n single_not_embedded_field = len(body_fields) == 1 and not embed_body_fields\n first_field = body_fields[0]\n body_to_process = received_body\n if isinstance(received_body, FormData):\n body_to_process = await _extract_form_body(body_fields, received_body)\n\n if single_not_embedded_field:\n loc: Tuple[str, ...] = (\"body\",)\n v_, errors_ = _validate_value_with_model_field(\n field=first_field, value=body_to_process, values=values, loc=loc\n )\n return {first_field.name: v_}, errors_\n for field in body_fields:\n loc = (\"body\", field.alias)\n value: Optional[Any] = None\n if body_to_process is not None:\n try:\n value = body_to_process.get(field.alias)\n # If the received body is a list, not a dict\n except AttributeError:\n errors.append(get_missing_field_error(loc))\n continue\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"new_filtered_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n get_model_fields,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic import BaseModel\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(\n annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(\n annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(\n annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[...,\n Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"new_complete_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n get_model_fields,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic import BaseModel\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[..., Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form) and not lenient_issubclass(\n first_field.type_, BaseModel\n ):\n return True\n return False\n\n\nasync def _extract_form_body(\n body_fields: List[ModelField],\n received_body: FormData,\n) -> Dict[str, Any]:\n values = {}\n first_field = body_fields[0]\n first_field_info = first_field.field_info\n\n for field in body_fields:\n value = _get_multidict_value(field, received_body)\n if (\n isinstance(first_field_info, params.File)\n and is_bytes_field(field)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n is_bytes_sequence_field(field)\n and isinstance(first_field_info, params.File)\n and value_is_sequence(value)\n ):\n # For types\n assert isinstance(value, sequence_types) # type: ignore[arg-type]\n results: List[Union[bytes, str]] = []\n\n async def process_fn(\n fn: Callable[[], Coroutine[Any, Any, Any]],\n ) -> None:\n result = await fn()\n results.append(result) # noqa: B023\n\n async with anyio.create_task_group() as tg:\n for sub_value in value:\n tg.start_soon(process_fn, sub_value.read)\n value = serialize_sequence_value(field=field, value=results)\n if value is not None:\n values[field.name] = value\n for key, value in received_body.items():\n if key not in values:\n values[key] = value\n return values\n\n\nasync def request_body_to_args(\n body_fields: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n embed_body_fields: bool,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n values: Dict[str, Any] = {}\n errors: List[Dict[str, Any]] = []\n assert body_fields, \"request_body_to_args() should be called with fields\"\n single_not_embedded_field = len(body_fields) == 1 and not embed_body_fields\n first_field = body_fields[0]\n body_to_process = received_body\n\n fields_to_extract: List[ModelField] = body_fields\n\n if single_not_embedded_field and lenient_issubclass(first_field.type_, BaseModel):\n fields_to_extract = get_model_fields(first_field.type_)\n\n if isinstance(received_body, FormData):\n body_to_process = await _extract_form_body(fields_to_extract, received_body)\n\n if single_not_embedded_field:\n loc: Tuple[str, ...] = (\"body\",)\n v_, errors_ = _validate_value_with_model_field(\n field=first_field, value=body_to_process, values=values, loc=loc\n )\n return {first_field.name: v_}, errors_\n for field in body_fields:\n loc = (\"body\", field.alias)\n value: Optional[Any] = None\n if body_to_process is not None:\n try:\n value = body_to_process.get(field.alias)\n # If the received body is a list, not a dict\n except AttributeError:\n errors.append(get_missing_field_error(loc))\n continue\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_multipart_installation.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_multipart_installation.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_multipart_installation.py:2: in <module>\n from fastapi import FastAPI, File, Form, UploadFile\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:23: in <module>\n from fastapi._compat import (\nE ImportError: cannot import name 'get_model_fields' from 'fastapi._compat' (/workspace/test_repo/fastapi/_compat.py)\n=========================== short test summary info ============================\nERROR tests/test_multipart_installation.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 10, 'passed': 10, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/dependencies/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_multipart_installation.py"}}},{"rowIdx":47,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__get_body_field__b9d912c6380661647b51c322820fcb4ba08f32d2"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b9d912c6380661647b51c322820fcb4ba08f32d2"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_body_field"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def get_body_field(*, dependant: Dependant, name: str):\n flat_dependant = get_flat_dependant(dependant)\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n embed = getattr(first_param.schema, \"embed\", None)\n if len(flat_dependant.body_params) == 1 and not embed:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_model(model_name)\n for f in flat_dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(True for f in flat_dependant.body_params if f.required)\n if any(isinstance(f.schema, params.File) for f in flat_dependant.body_params):\n BodySchema = params.File\n elif any(isinstance(f.schema, params.Form) for f in flat_dependant.body_params):\n BodySchema = params.Form\n else:\n BodySchema = params.Body\n\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=BodySchema(None),\n )\n return field\n"},"gold_code":{"kind":"string","value":"def get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom copy import deepcopy\nfrom typing import Any, Callable, Dict, List, Tuple\n\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.requests import Request\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.utils import get_path_param_names\nfrom pydantic import BaseConfig, Schema, create_model\nfrom pydantic.error_wrappers import ErrorWrapper\nfrom pydantic.errors import MissingError\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic.utils import lenient_issubclass\n\nparam_supported_types = (str, int, float, bool)\n\n\ndef get_sub_dependant(*, param: inspect.Parameter, path: str):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(depends, params.Security) and isinstance(dependency, SecurityBase):\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=depends.scopes\n )\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_requirements.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_dependant(*, path: str, call: Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ) or param.annotation == param.empty, f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig(),\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable = None):\n if not call:\n return False\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(\n *, request: Request, dependant: Dependant, body: Dict[str, Any] = None\n):\n values: Dict[str, Any] = {}\n errors: List[ErrorWrapper] = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant, body=body\n )\n if sub_errors:\n return {}, errors\n if sub_dependant.call and is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[\n sub_dependant.name\n ] = solved # type: ignore # Sub-dependants always have a name\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body_values, body_errors = await request_body_to_args( # type: ignore # body_params checked above\n dependant.body_params, body\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef request_params_to_args(\n required_params: List[Field], received_params: Dict[str, Any]\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\nasync def request_body_to_args(\n required_params: List[Field], received_body: Dict[str, Any]\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n embed = getattr(field.schema, \"embed\", None)\n if len(required_params) == 1 and not embed:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n default = None,\n required = required,\n model_config = BaseConfig,\n class_validators = [],\n alias = \"body\",\n schema = BodySchema(None),\n )\n return field\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom copy import deepcopy\nfrom typing import Any, Callable, Dict, List, Tuple\n\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.requests import Request\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.utils import get_path_param_names\nfrom pydantic import BaseConfig, Schema, create_model\nfrom pydantic.error_wrappers import ErrorWrapper\nfrom pydantic.errors import MissingError\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic.utils import lenient_issubclass\n\nparam_supported_types = (str, int, float, bool)\n\n\ndef get_sub_dependant(*, param: inspect.Parameter, path: str):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(depends, params.Security) and isinstance(dependency, SecurityBase):\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=depends.scopes\n )\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_requirements.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_dependant(*, path: str, call: Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ) or param.annotation == param.empty, f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig(),\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable = None):\n if not call:\n return False\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(\n *, request: Request, dependant: Dependant, body: Dict[str, Any] = None\n):\n values: Dict[str, Any] = {}\n errors: List[ErrorWrapper] = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant, body=body\n )\n if sub_errors:\n return {}, errors\n if sub_dependant.call and is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[\n sub_dependant.name\n ] = solved # type: ignore # Sub-dependants always have a name\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body_values, body_errors = await request_body_to_args( # type: ignore # body_params checked above\n dependant.body_params, body\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef request_params_to_args(\n required_params: List[Field], received_params: Dict[str, Any]\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\nasync def request_body_to_args(\n required_params: List[Field], received_body: Dict[str, Any]\n) -> Tuple[Dict[str, Any], List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n embed = getattr(field.schema, \"embed\", None)\n if len(required_params) == 1 and not embed:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(*, dependant: Dependant, name: str):\n flat_dependant = get_flat_dependant(dependant)\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n embed = getattr(first_param.schema, \"embed\", None)\n if len(flat_dependant.body_params) == 1 and not embed:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_model(model_name)\n for f in flat_dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(True for f in flat_dependant.body_params if f.required)\n if any(isinstance(f.schema, params.File) for f in flat_dependant.body_params):\n BodySchema = params.File\n elif any(isinstance(f.schema, params.Form) for f in flat_dependant.body_params):\n BodySchema = params.Form\n else:\n BodySchema = params.Body\n\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=BodySchema(None),\n )\n return field\n"},"new_filtered_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n get_model_fields,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic import BaseModel\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(\n flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(\n annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(\n annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(\n annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[...,\n Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form) and not lenient_issubclass(\n first_field.type_, BaseModel\n ):\n return True\n return False\n\n\nasync def _extract_form_body(\n body_fields: List[ModelField],\n received_body: FormData,\n) -> Dict[str, Any]:\n values = {}\n first_field = body_fields[0]\n first_field_info = first_field.field_info\n\n for field in body_fields:\n value = _get_multidict_value(field, received_body)\n if (\n isinstance(first_field_info, params.File)\n and is_bytes_field(field)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n is_bytes_sequence_field(field)\n and isinstance(first_field_info, params.File)\n and value_is_sequence(value)\n ):\n # For types\n assert isinstance(value, sequence_types) # type: ignore[arg-type]\n results: List[Union[bytes, str]] = []\n\n async def process_fn(\n fn: Callable[[], Coroutine[Any, Any, Any]],\n ) -> None:\n result = await fn()\n results.append(result) # noqa: B023\n\n async with anyio.create_task_group() as tg:\n for sub_value in value:\n tg.start_soon(process_fn, sub_value.read)\n value = serialize_sequence_value(field=field, value=results)\n if value is not None:\n values[field.name] = value\n for key, value in received_body.items():\n if key not in values:\n values[key] = value\n return values\n\n\nasync def request_body_to_args(\n body_fields: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n embed_body_fields: bool,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n values: Dict[str, Any] = {}\n errors: List[Dict[str, Any]] = []\n assert body_fields, \"request_body_to_args() should be called with fields\"\n single_not_embedded_field = len(body_fields) == 1 and not embed_body_fields\n first_field = body_fields[0]\n body_to_process = received_body\n\n fields_to_extract: List[ModelField] = body_fields\n\n if single_not_embedded_field and lenient_issubclass(first_field.type_, BaseModel):\n fields_to_extract = get_model_fields(first_field.type_)\n\n if isinstance(received_body, FormData):\n body_to_process = await _extract_form_body(fields_to_extract, received_body)\n\n if single_not_embedded_field:\n loc: Tuple[str, ...] = (\"body\",)\n v_, errors_ = _validate_value_with_model_field(\n field=first_field, value=body_to_process, values=values, loc=loc\n )\n return {first_field.name: v_}, errors_\n for field in body_fields:\n loc = (\"body\", field.alias)\n value: Optional[Any] = None\n if body_to_process is not None:\n try:\n value = body_to_process.get(field.alias)\n # If the received body is a list, not a dict\n except AttributeError:\n errors.append(get_missing_field_error(loc))\n continue\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n"},"new_complete_context":{"kind":"string","value":"import inspect\nfrom contextlib import AsyncExitStack, contextmanager\nfrom copy import copy, deepcopy\nfrom dataclasses import dataclass\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n ForwardRef,\n List,\n Mapping,\n Optional,\n Sequence,\n Tuple,\n Type,\n Union,\n cast,\n)\n\nimport anyio\nfrom fastapi import params\nfrom fastapi._compat import (\n PYDANTIC_V2,\n ErrorWrapper,\n ModelField,\n Required,\n Undefined,\n _regenerate_error_with_loc,\n copy_field_info,\n create_body_model,\n evaluate_forwardref,\n field_annotation_is_scalar,\n get_annotation_from_field_info,\n get_missing_field_error,\n get_model_fields,\n is_bytes_field,\n is_bytes_sequence_field,\n is_scalar_field,\n is_scalar_sequence_field,\n is_sequence_field,\n is_uploadfile_or_nonable_uploadfile_annotation,\n is_uploadfile_sequence_annotation,\n lenient_issubclass,\n sequence_types,\n serialize_sequence_value,\n value_is_sequence,\n)\nfrom fastapi.background import BackgroundTasks\nfrom fastapi.concurrency import (\n asynccontextmanager,\n contextmanager_in_threadpool,\n)\nfrom fastapi.dependencies.models import Dependant, SecurityRequirement\nfrom fastapi.logger import logger\nfrom fastapi.security.base import SecurityBase\nfrom fastapi.security.oauth2 import OAuth2, SecurityScopes\nfrom fastapi.security.open_id_connect_url import OpenIdConnect\nfrom fastapi.utils import create_model_field, get_path_param_names\nfrom pydantic import BaseModel\nfrom pydantic.fields import FieldInfo\nfrom starlette.background import BackgroundTasks as StarletteBackgroundTasks\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.datastructures import (\n FormData,\n Headers,\n ImmutableMultiDict,\n QueryParams,\n UploadFile,\n)\nfrom starlette.requests import HTTPConnection, Request\nfrom starlette.responses import Response\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, get_args, get_origin\n\nmultipart_not_installed_error = (\n 'Form data requires \"python-multipart\" to be installed. \\n'\n 'You can install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\nmultipart_incorrect_install_error = (\n 'Form data requires \"python-multipart\" to be installed. '\n 'It seems you installed \"multipart\" instead. \\n'\n 'You can remove \"multipart\" with: \\n\\n'\n \"pip uninstall multipart\\n\\n\"\n 'And then install \"python-multipart\" with: \\n\\n'\n \"pip install python-multipart\\n\"\n)\n\n\ndef ensure_multipart_is_installed() -> None:\n try:\n # __version__ is available in both multiparts, and can be mocked\n from multipart import __version__ # type: ignore\n\n assert __version__\n try:\n # parse_options_header is only available in the right multipart\n from multipart.multipart import parse_options_header # type: ignore\n\n assert parse_options_header\n except ImportError:\n logger.error(multipart_incorrect_install_error)\n raise RuntimeError(multipart_incorrect_install_error) from None\n except ImportError:\n logger.error(multipart_not_installed_error)\n raise RuntimeError(multipart_not_installed_error) from None\n\n\ndef get_param_sub_dependant(\n *,\n param_name: str,\n depends: params.Depends,\n path: str,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n assert depends.dependency\n return get_sub_dependant(\n depends=depends,\n dependency=depends.dependency,\n path=path,\n name=param_name,\n security_scopes=security_scopes,\n )\n\n\ndef get_parameterless_sub_dependant(*, depends: params.Depends, path: str) -> Dependant:\n assert callable(\n depends.dependency\n ), \"A parameter-less dependency must have a callable dependency\"\n return get_sub_dependant(depends=depends, dependency=depends.dependency, path=path)\n\n\ndef get_sub_dependant(\n *,\n depends: params.Depends,\n dependency: Callable[..., Any],\n path: str,\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n) -> Dependant:\n security_requirement = None\n security_scopes = security_scopes or []\n if isinstance(depends, params.Security):\n dependency_scopes = depends.scopes\n security_scopes.extend(dependency_scopes)\n if isinstance(dependency, SecurityBase):\n use_scopes: List[str] = []\n if isinstance(dependency, (OAuth2, OpenIdConnect)):\n use_scopes = security_scopes\n security_requirement = SecurityRequirement(\n security_scheme=dependency, scopes=use_scopes\n )\n sub_dependant = get_dependant(\n path=path,\n call=dependency,\n name=name,\n security_scopes=security_scopes,\n use_cache=depends.use_cache,\n )\n if security_requirement:\n sub_dependant.security_requirements.append(security_requirement)\n return sub_dependant\n\n\nCacheKey = Tuple[Optional[Callable[..., Any]], Tuple[str, ...]]\n\n\ndef get_flat_dependant(\n dependant: Dependant,\n *,\n skip_repeats: bool = False,\n visited: Optional[List[CacheKey]] = None,\n) -> Dependant:\n if visited is None:\n visited = []\n visited.append(dependant.cache_key)\n\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_requirements=dependant.security_requirements.copy(),\n use_cache=dependant.use_cache,\n path=dependant.path,\n )\n for sub_dependant in dependant.dependencies:\n if skip_repeats and sub_dependant.cache_key in visited:\n continue\n flat_sub = get_flat_dependant(\n sub_dependant, skip_repeats=skip_repeats, visited=visited\n )\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_requirements.extend(flat_sub.security_requirements)\n return flat_dependant\n\n\ndef get_flat_params(dependant: Dependant) -> List[ModelField]:\n flat_dependant = get_flat_dependant(dependant, skip_repeats=True)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\ndef get_typed_signature(call: Callable[..., Any]) -> inspect.Signature:\n signature = inspect.signature(call)\n globalns = getattr(call, \"__globals__\", {})\n typed_params = [\n inspect.Parameter(\n name=param.name,\n kind=param.kind,\n default=param.default,\n annotation=get_typed_annotation(param.annotation, globalns),\n )\n for param in signature.parameters.values()\n ]\n typed_signature = inspect.Signature(typed_params)\n return typed_signature\n\n\ndef get_typed_annotation(annotation: Any, globalns: Dict[str, Any]) -> Any:\n if isinstance(annotation, str):\n annotation = ForwardRef(annotation)\n annotation = evaluate_forwardref(annotation, globalns, globalns)\n return annotation\n\n\ndef get_typed_return_annotation(call: Callable[..., Any]) -> Any:\n signature = inspect.signature(call)\n annotation = signature.return_annotation\n\n if annotation is inspect.Signature.empty:\n return None\n\n globalns = getattr(call, \"__globals__\", {})\n return get_typed_annotation(annotation, globalns)\n\n\ndef get_dependant(\n *,\n path: str,\n call: Callable[..., Any],\n name: Optional[str] = None,\n security_scopes: Optional[List[str]] = None,\n use_cache: bool = True,\n) -> Dependant:\n path_param_names = get_path_param_names(path)\n endpoint_signature = get_typed_signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(\n call=call,\n name=name,\n path=path,\n security_scopes=security_scopes,\n use_cache=use_cache,\n )\n for param_name, param in signature_params.items():\n is_path_param = param_name in path_param_names\n param_details = analyze_param(\n param_name=param_name,\n annotation=param.annotation,\n value=param.default,\n is_path_param=is_path_param,\n )\n if param_details.depends is not None:\n sub_dependant = get_param_sub_dependant(\n param_name=param_name,\n depends=param_details.depends,\n path=path,\n security_scopes=security_scopes,\n )\n dependant.dependencies.append(sub_dependant)\n continue\n if add_non_field_param_to_dependency(\n param_name=param_name,\n type_annotation=param_details.type_annotation,\n dependant=dependant,\n ):\n assert (\n param_details.field is None\n ), f\"Cannot specify multiple FastAPI annotations for {param_name!r}\"\n continue\n assert param_details.field is not None\n if isinstance(param_details.field.field_info, params.Body):\n dependant.body_params.append(param_details.field)\n else:\n add_param_to_fields(field=param_details.field, dependant=dependant)\n return dependant\n\n\ndef add_non_field_param_to_dependency(\n *, param_name: str, type_annotation: Any, dependant: Dependant\n) -> Optional[bool]:\n if lenient_issubclass(type_annotation, Request):\n dependant.request_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, WebSocket):\n dependant.websocket_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, HTTPConnection):\n dependant.http_connection_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, Response):\n dependant.response_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):\n dependant.background_tasks_param_name = param_name\n return True\n elif lenient_issubclass(type_annotation, SecurityScopes):\n dependant.security_scopes_param_name = param_name\n return True\n return None\n\n\n@dataclass\nclass ParamDetails:\n type_annotation: Any\n depends: Optional[params.Depends]\n field: Optional[ModelField]\n\n\ndef analyze_param(\n *,\n param_name: str,\n annotation: Any,\n value: Any,\n is_path_param: bool,\n) -> ParamDetails:\n field_info = None\n depends = None\n type_annotation: Any = Any\n use_annotation: Any = Any\n if annotation is not inspect.Signature.empty:\n use_annotation = annotation\n type_annotation = annotation\n # Extract Annotated info\n if get_origin(use_annotation) is Annotated:\n annotated_args = get_args(annotation)\n type_annotation = annotated_args[0]\n fastapi_annotations = [\n arg\n for arg in annotated_args[1:]\n if isinstance(arg, (FieldInfo, params.Depends))\n ]\n fastapi_specific_annotations = [\n arg\n for arg in fastapi_annotations\n if isinstance(arg, (params.Param, params.Body, params.Depends))\n ]\n if fastapi_specific_annotations:\n fastapi_annotation: Union[FieldInfo, params.Depends, None] = (\n fastapi_specific_annotations[-1]\n )\n else:\n fastapi_annotation = None\n # Set default for Annotated FieldInfo\n if isinstance(fastapi_annotation, FieldInfo):\n # Copy `field_info` because we mutate `field_info.default` below.\n field_info = copy_field_info(\n field_info=fastapi_annotation, annotation=use_annotation\n )\n assert field_info.default is Undefined or field_info.default is Required, (\n f\"`{field_info.__class__.__name__}` default value cannot be set in\"\n f\" `Annotated` for {param_name!r}. Set the default value with `=` instead.\"\n )\n if value is not inspect.Signature.empty:\n assert not is_path_param, \"Path parameters cannot have default values\"\n field_info.default = value\n else:\n field_info.default = Required\n # Get Annotated Depends\n elif isinstance(fastapi_annotation, params.Depends):\n depends = fastapi_annotation\n # Get Depends from default value\n if isinstance(value, params.Depends):\n assert depends is None, (\n \"Cannot specify `Depends` in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n assert field_info is None, (\n \"Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a\"\n f\" default value together for {param_name!r}\"\n )\n depends = value\n # Get FieldInfo from default value\n elif isinstance(value, FieldInfo):\n assert field_info is None, (\n \"Cannot specify FastAPI annotations in `Annotated` and default value\"\n f\" together for {param_name!r}\"\n )\n field_info = value\n if PYDANTIC_V2:\n field_info.annotation = type_annotation\n\n # Get Depends from type annotation\n if depends is not None and depends.dependency is None:\n # Copy `depends` before mutating it\n depends = copy(depends)\n depends.dependency = type_annotation\n\n # Handle non-param type annotations like Request\n if lenient_issubclass(\n type_annotation,\n (\n Request,\n WebSocket,\n HTTPConnection,\n Response,\n StarletteBackgroundTasks,\n SecurityScopes,\n ),\n ):\n assert depends is None, f\"Cannot specify `Depends` for type {type_annotation!r}\"\n assert (\n field_info is None\n ), f\"Cannot specify FastAPI annotation for type {type_annotation!r}\"\n # Handle default assignations, neither field_info nor depends was not found in Annotated nor default value\n elif field_info is None and depends is None:\n default_value = value if value is not inspect.Signature.empty else Required\n if is_path_param:\n # We might check here that `default_value is Required`, but the fact is that the same\n # parameter might sometimes be a path parameter and sometimes not. See\n # `tests/test_infer_param_optionality.py` for an example.\n field_info = params.Path(annotation=use_annotation)\n elif is_uploadfile_or_nonable_uploadfile_annotation(\n type_annotation\n ) or is_uploadfile_sequence_annotation(type_annotation):\n field_info = params.File(annotation=use_annotation, default=default_value)\n elif not field_annotation_is_scalar(annotation=type_annotation):\n field_info = params.Body(annotation=use_annotation, default=default_value)\n else:\n field_info = params.Query(annotation=use_annotation, default=default_value)\n\n field = None\n # It's a field_info, not a dependency\n if field_info is not None:\n # Handle field_info.in_\n if is_path_param:\n assert isinstance(field_info, params.Path), (\n f\"Cannot use `{field_info.__class__.__name__}` for path param\"\n f\" {param_name!r}\"\n )\n elif (\n isinstance(field_info, params.Param)\n and getattr(field_info, \"in_\", None) is None\n ):\n field_info.in_ = params.ParamTypes.query\n use_annotation_from_field_info = get_annotation_from_field_info(\n use_annotation,\n field_info,\n param_name,\n )\n if isinstance(field_info, params.Form):\n ensure_multipart_is_installed()\n if not field_info.alias and getattr(field_info, \"convert_underscores\", None):\n alias = param_name.replace(\"_\", \"-\")\n else:\n alias = field_info.alias or param_name\n field_info.alias = alias\n field = create_model_field(\n name=param_name,\n type_=use_annotation_from_field_info,\n default=field_info.default,\n alias=alias,\n required=field_info.default in (Required, Undefined),\n field_info=field_info,\n )\n if is_path_param:\n assert is_scalar_field(\n field=field\n ), \"Path params must be of one of the supported types\"\n elif isinstance(field_info, params.Query):\n assert is_scalar_field(field) or is_scalar_sequence_field(field)\n\n return ParamDetails(type_annotation=type_annotation, depends=depends, field=field)\n\n\ndef add_param_to_fields(*, field: ModelField, dependant: Dependant) -> None:\n field_info = field.field_info\n field_info_in = getattr(field_info, \"in_\", None)\n if field_info_in == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif field_info_in == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif field_info_in == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n field_info_in == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {field.name}\"\n dependant.cookie_params.append(field)\n\n\ndef is_coroutine_callable(call: Callable[..., Any]) -> bool:\n if inspect.isroutine(call):\n return inspect.iscoroutinefunction(call)\n if inspect.isclass(call):\n return False\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.iscoroutinefunction(dunder_call)\n\n\ndef is_async_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isasyncgenfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isasyncgenfunction(dunder_call)\n\n\ndef is_gen_callable(call: Callable[..., Any]) -> bool:\n if inspect.isgeneratorfunction(call):\n return True\n dunder_call = getattr(call, \"__call__\", None) # noqa: B004\n return inspect.isgeneratorfunction(dunder_call)\n\n\nasync def solve_generator(\n *, call: Callable[..., Any], stack: AsyncExitStack, sub_values: Dict[str, Any]\n) -> Any:\n if is_gen_callable(call):\n cm = contextmanager_in_threadpool(contextmanager(call)(**sub_values))\n elif is_async_gen_callable(call):\n cm = asynccontextmanager(call)(**sub_values)\n return await stack.enter_async_context(cm)\n\n\n@dataclass\nclass SolvedDependency:\n values: Dict[str, Any]\n errors: List[Any]\n background_tasks: Optional[StarletteBackgroundTasks]\n response: Response\n dependency_cache: Dict[Tuple[Callable[..., Any], Tuple[str]], Any]\n\n\nasync def solve_dependencies(\n *,\n request: Union[Request, WebSocket],\n dependant: Dependant,\n body: Optional[Union[Dict[str, Any], FormData]] = None,\n background_tasks: Optional[StarletteBackgroundTasks] = None,\n response: Optional[Response] = None,\n dependency_overrides_provider: Optional[Any] = None,\n dependency_cache: Optional[Dict[Tuple[Callable[..., Any], Tuple[str]], Any]] = None,\n async_exit_stack: AsyncExitStack,\n embed_body_fields: bool,\n) -> SolvedDependency:\n values: Dict[str, Any] = {}\n errors: List[Any] = []\n if response is None:\n response = Response()\n del response.headers[\"content-length\"]\n response.status_code = None # type: ignore\n dependency_cache = dependency_cache or {}\n sub_dependant: Dependant\n for sub_dependant in dependant.dependencies:\n sub_dependant.call = cast(Callable[..., Any], sub_dependant.call)\n sub_dependant.cache_key = cast(\n Tuple[Callable[..., Any], Tuple[str]], sub_dependant.cache_key\n )\n call = sub_dependant.call\n use_sub_dependant = sub_dependant\n if (\n dependency_overrides_provider\n and dependency_overrides_provider.dependency_overrides\n ):\n original_call = sub_dependant.call\n call = getattr(\n dependency_overrides_provider, \"dependency_overrides\", {}\n ).get(original_call, original_call)\n use_path: str = sub_dependant.path # type: ignore\n use_sub_dependant = get_dependant(\n path=use_path,\n call=call,\n name=sub_dependant.name,\n security_scopes=sub_dependant.security_scopes,\n )\n\n solved_result = await solve_dependencies(\n request=request,\n dependant=use_sub_dependant,\n body=body,\n background_tasks=background_tasks,\n response=response,\n dependency_overrides_provider=dependency_overrides_provider,\n dependency_cache=dependency_cache,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n background_tasks = solved_result.background_tasks\n dependency_cache.update(solved_result.dependency_cache)\n if solved_result.errors:\n errors.extend(solved_result.errors)\n continue\n if sub_dependant.use_cache and sub_dependant.cache_key in dependency_cache:\n solved = dependency_cache[sub_dependant.cache_key]\n elif is_gen_callable(call) or is_async_gen_callable(call):\n solved = await solve_generator(\n call=call, stack=async_exit_stack, sub_values=solved_result.values\n )\n elif is_coroutine_callable(call):\n solved = await call(**solved_result.values)\n else:\n solved = await run_in_threadpool(call, **solved_result.values)\n if sub_dependant.name is not None:\n values[sub_dependant.name] = solved\n if sub_dependant.cache_key not in dependency_cache:\n dependency_cache[sub_dependant.cache_key] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors += path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n (\n body_values,\n body_errors,\n ) = await request_body_to_args( # body_params checked above\n body_fields=dependant.body_params,\n received_body=body,\n embed_body_fields=embed_body_fields,\n )\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.http_connection_param_name:\n values[dependant.http_connection_param_name] = request\n if dependant.request_param_name and isinstance(request, Request):\n values[dependant.request_param_name] = request\n elif dependant.websocket_param_name and isinstance(request, WebSocket):\n values[dependant.websocket_param_name] = request\n if dependant.background_tasks_param_name:\n if background_tasks is None:\n background_tasks = BackgroundTasks()\n values[dependant.background_tasks_param_name] = background_tasks\n if dependant.response_param_name:\n values[dependant.response_param_name] = response\n if dependant.security_scopes_param_name:\n values[dependant.security_scopes_param_name] = SecurityScopes(\n scopes=dependant.security_scopes\n )\n return SolvedDependency(\n values=values,\n errors=errors,\n background_tasks=background_tasks,\n response=response,\n dependency_cache=dependency_cache,\n )\n\n\ndef _validate_value_with_model_field(\n *, field: ModelField, value: Any, values: Dict[str, Any], loc: Tuple[str, ...]\n) -> Tuple[Any, List[Any]]:\n if value is None:\n if field.required:\n return None, [get_missing_field_error(loc=loc)]\n else:\n return deepcopy(field.default), []\n v_, errors_ = field.validate(value, values, loc=loc)\n if isinstance(errors_, ErrorWrapper):\n return None, [errors_]\n elif isinstance(errors_, list):\n new_errors = _regenerate_error_with_loc(errors=errors_, loc_prefix=())\n return None, new_errors\n else:\n return v_, []\n\n\ndef _get_multidict_value(field: ModelField, values: Mapping[str, Any]) -> Any:\n if is_sequence_field(field) and isinstance(values, (ImmutableMultiDict, Headers)):\n value = values.getlist(field.alias)\n else:\n value = values.get(field.alias, None)\n if (\n value is None\n or (\n isinstance(field.field_info, params.Form)\n and isinstance(value, str) # For type checks\n and value == \"\"\n )\n or (is_sequence_field(field) and len(value) == 0)\n ):\n if field.required:\n return\n else:\n return deepcopy(field.default)\n return value\n\n\ndef request_params_to_args(\n fields: Sequence[ModelField],\n received_params: Union[Mapping[str, Any], QueryParams, Headers],\n) -> Tuple[Dict[str, Any], List[Any]]:\n values: Dict[str, Any] = {}\n errors = []\n for field in fields:\n value = _get_multidict_value(field, received_params)\n field_info = field.field_info\n assert isinstance(\n field_info, params.Param\n ), \"Params must be subclasses of Param\"\n loc = (field_info.in_.value, field.alias)\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef _should_embed_body_fields(fields: List[ModelField]) -> bool:\n if not fields:\n return False\n # More than one dependency could have the same field, it would show up as multiple\n # fields but it's the same one, so count them by name\n body_param_names_set = {field.name for field in fields}\n # A top level field has to be a single field, not multiple\n if len(body_param_names_set) > 1:\n return True\n first_field = fields[0]\n # If it explicitly specifies it is embedded, it has to be embedded\n if getattr(first_field.field_info, \"embed\", None):\n return True\n # If it's a Form (or File) field, it has to be a BaseModel to be top level\n # otherwise it has to be embedded, so that the key value pair can be extracted\n if isinstance(first_field.field_info, params.Form) and not lenient_issubclass(\n first_field.type_, BaseModel\n ):\n return True\n return False\n\n\nasync def _extract_form_body(\n body_fields: List[ModelField],\n received_body: FormData,\n) -> Dict[str, Any]:\n values = {}\n first_field = body_fields[0]\n first_field_info = first_field.field_info\n\n for field in body_fields:\n value = _get_multidict_value(field, received_body)\n if (\n isinstance(first_field_info, params.File)\n and is_bytes_field(field)\n and isinstance(value, UploadFile)\n ):\n value = await value.read()\n elif (\n is_bytes_sequence_field(field)\n and isinstance(first_field_info, params.File)\n and value_is_sequence(value)\n ):\n # For types\n assert isinstance(value, sequence_types) # type: ignore[arg-type]\n results: List[Union[bytes, str]] = []\n\n async def process_fn(\n fn: Callable[[], Coroutine[Any, Any, Any]],\n ) -> None:\n result = await fn()\n results.append(result) # noqa: B023\n\n async with anyio.create_task_group() as tg:\n for sub_value in value:\n tg.start_soon(process_fn, sub_value.read)\n value = serialize_sequence_value(field=field, value=results)\n if value is not None:\n values[field.name] = value\n for key, value in received_body.items():\n if key not in values:\n values[key] = value\n return values\n\n\nasync def request_body_to_args(\n body_fields: List[ModelField],\n received_body: Optional[Union[Dict[str, Any], FormData]],\n embed_body_fields: bool,\n) -> Tuple[Dict[str, Any], List[Dict[str, Any]]]:\n values: Dict[str, Any] = {}\n errors: List[Dict[str, Any]] = []\n assert body_fields, \"request_body_to_args() should be called with fields\"\n single_not_embedded_field = len(body_fields) == 1 and not embed_body_fields\n first_field = body_fields[0]\n body_to_process = received_body\n\n fields_to_extract: List[ModelField] = body_fields\n\n if single_not_embedded_field and lenient_issubclass(first_field.type_, BaseModel):\n fields_to_extract = get_model_fields(first_field.type_)\n\n if isinstance(received_body, FormData):\n body_to_process = await _extract_form_body(fields_to_extract, received_body)\n\n if single_not_embedded_field:\n loc: Tuple[str, ...] = (\"body\",)\n v_, errors_ = _validate_value_with_model_field(\n field=first_field, value=body_to_process, values=values, loc=loc\n )\n return {first_field.name: v_}, errors_\n for field in body_fields:\n loc = (\"body\", field.alias)\n value: Optional[Any] = None\n if body_to_process is not None:\n try:\n value = body_to_process.get(field.alias)\n # If the received body is a list, not a dict\n except AttributeError:\n errors.append(get_missing_field_error(loc))\n continue\n v_, errors_ = _validate_value_with_model_field(\n field=field, value=value, values=values, loc=loc\n )\n if errors_:\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef get_body_field(\n *, flat_dependant: Dependant, name: str, embed_body_fields: bool\n) -> Optional[ModelField]:\n \"\"\"\n Get a ModelField representing the request body for a path operation, combining\n all body parameters into a single field if necessary.\n\n Used to check if it's form data (with `isinstance(body_field, params.Form)`)\n or JSON and to generate the JSON Schema for a request body.\n\n This is **not** used to validate/parse the request body, that's done with each\n individual body parameter.\n \"\"\"\n if not flat_dependant.body_params:\n return None\n first_param = flat_dependant.body_params[0]\n if not embed_body_fields:\n return first_param\n model_name = \"Body_\" + name\n BodyModel = create_body_model(\n fields=flat_dependant.body_params, model_name=model_name\n )\n required = any(True for f in flat_dependant.body_params if f.required)\n BodyFieldInfo_kwargs: Dict[str, Any] = {\n \"annotation\": BodyModel,\n \"alias\": \"body\",\n }\n if not required:\n BodyFieldInfo_kwargs[\"default\"] = None\n if any(isinstance(f.field_info, params.File) for f in flat_dependant.body_params):\n BodyFieldInfo: Type[params.Body] = params.File\n elif any(isinstance(f.field_info, params.Form) for f in flat_dependant.body_params):\n BodyFieldInfo = params.Form\n else:\n BodyFieldInfo = params.Body\n\n body_param_media_types = [\n f.field_info.media_type\n for f in flat_dependant.body_params\n if isinstance(f.field_info, params.Body)\n ]\n if len(set(body_param_media_types)) == 1:\n BodyFieldInfo_kwargs[\"media_type\"] = body_param_media_types[0]\n final_field = create_model_field(\n name=\"body\",\n type_=BodyModel,\n required=required,\n alias=\"body\",\n field_info=BodyFieldInfo(**BodyFieldInfo_kwargs),\n )\n return final_field\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_multipart_installation.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_multipart_installation.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_multipart_installation.py:2: in <module>\n from fastapi import FastAPI, File, Form, UploadFile\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:23: in <module>\n from fastapi._compat import (\nE ImportError: cannot import name 'get_model_fields' from 'fastapi._compat' (/workspace/test_repo/fastapi/_compat.py)\n=========================== short test summary info ============================\nERROR tests/test_multipart_installation.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 10, 'passed': 10, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/dependencies/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_multipart_installation.py"}}},{"rowIdx":48,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__is_body_allowed_for_status_code__c43120258fa89bc20d6f8ee671b6ead9ab223fc7"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"c43120258fa89bc20d6f8ee671b6ead9ab223fc7"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"is_body_allowed_for_status_code"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 304})\n"},"gold_code":{"kind":"string","value":"def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 304})\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo()\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n________________ ERROR collecting tests/test_computed_fields.py ________________\nImportError while importing test module '/workspace/test_repo/tests/test_computed_fields.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_computed_fields.py:2: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_computed_fields.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 2, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_computed_fields.py"}}},{"rowIdx":49,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__get_path_param_names__b9d912c6380661647b51c322820fcb4ba08f32d2"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b9d912c6380661647b51c322820fcb4ba08f32d2"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_path_param_names"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n"},"gold_code":{"kind":"string","value":"def get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Dict, Sequence, Set, Type\n\nfrom starlette.routing import BaseRoute\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseModel\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]):\n body_fields_from_routes = []\n responses_from_routes = []\n for route in routes:\n if route.include_in_schema and isinstance(route, routing.APIRoute):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n):\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Dict, Sequence, Set, Type\n\nfrom starlette.routing import BaseRoute\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseModel\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]):\n body_fields_from_routes = []\n responses_from_routes = []\n for route in routes:\n if route.include_in_schema and isinstance(route, routing.APIRoute):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n):\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n________________ ERROR collecting tests/test_computed_fields.py ________________\nImportError while importing test module '/workspace/test_repo/tests/test_computed_fields.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_computed_fields.py:2: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_computed_fields.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 2, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_computed_fields.py"}}},{"rowIdx":50,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__create_cloned_field__aa84ac8e3e305d76e71c0c1b31237517948fa12f"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"aa84ac8e3e305d76e71c0c1b31237517948fa12f"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"create_cloned_field"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"gold_code":{"kind":"string","value":"def create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(\n routes: Sequence[Type[BaseRoute]]\n) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n default = None,\n required = False,\n model_config = BaseConfig,\n schema = Schema(None),\n )\n new_field.has_alias= field.has_alias\n new_field.alias= field.alias\n new_field.class_validators= field.class_validators\n new_field.default= field.default\n new_field.required= field.required\n new_field.model_config= field.model_config\n new_field.schema= field.schema\n new_field.allow_none= field.allow_none\n new_field.validate_always= field.validate_always\n if field.sub_fields:\n new_field.sub_fields= [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(\n routes: Sequence[Type[BaseRoute]]\n) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n________________ ERROR collecting tests/test_computed_fields.py ________________\ntests/test_computed_fields.py:2: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nfastapi/utils.py:109: in <module>\n def create_cloned_field(field: Field) -> Field:\nE NameError: name 'Field' is not defined\n=========================== short test summary info ============================\nERROR tests/test_computed_fields.py - NameError: name 'Field' is not defined\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 2, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_computed_fields.py"}}},{"rowIdx":51,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__generate_operation_id_for_path__687065509b047a642acd1d281d6d68c6698509b1"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"687065509b047a642acd1d281d6d68c6698509b1"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"generate_operation_id_for_path"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"gold_code":{"kind":"string","value":"def generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n________________ ERROR collecting tests/test_computed_fields.py ________________\nImportError while importing test module '/workspace/test_repo/tests/test_computed_fields.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_computed_fields.py:2: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_computed_fields.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.61s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 2, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_computed_fields.py"}}},{"rowIdx":52,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__generate_unique_id__8a0d4c79c18e6bd219b965b9d50578c139e7efd8"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"8a0d4c79c18e6bd219b965b9d50578c139e7efd8"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"generate_unique_id"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n"},"gold_code":{"kind":"string","value":"def generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n________________ ERROR collecting tests/test_computed_fields.py ________________\nImportError while importing test module '/workspace/test_repo/tests/test_computed_fields.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_computed_fields.py:2: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_computed_fields.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 2, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_computed_fields.py"}}},{"rowIdx":53,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__deep_dict_update__181a32236a32305788b87d10e7990d9564ae2056"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"181a32236a32305788b87d10e7990d9564ae2056"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"deep_dict_update"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def deep_dict_update(main_dict: dict, update_dict: dict) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n"},"gold_code":{"kind":"string","value":"def deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\ntry:\n from pydantic.fields import FieldInfo, ModelField, UndefinedType\n\n PYDANTIC_1 = True\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n\n class UndefinedType: # type: ignore\n def __repr__(self) -> str:\n return \"PydanticUndefined\"\n\n logger.warning(\n \"Pydantic versions < 1.0.0 are deprecated in FastAPI and support will be \"\n \"removed soon.\"\n )\n PYDANTIC_1 = False\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef get_field_info(field: ModelField) -> FieldInfo:\n if PYDANTIC_1:\n return field.field_info # type: ignore\n else:\n return field.schema # type: ignore # pragma: nocover\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef warning_response_model_skip_defaults_deprecated() -> None:\n logger.warning( # pragma: nocover\n \"response_model_skip_defaults has been deprecated in favor of \"\n \"response_model_exclude_unset to keep in line with Pydantic v1, support for \"\n \"it will be removed soon.\"\n )\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n # ignore mypy error until enum schemas are released\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n if PYDANTIC_1:\n return response_field(field_info=field_info)\n else: # pragma: nocover\n return response_field(schema=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__ # type: ignore\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n if PYDANTIC_1:\n new_field.field_info = field.field_info\n else: # pragma: nocover\n new_field.schema = field.schema # type: ignore\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n if PYDANTIC_1:\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n else: # pragma: nocover\n new_field.whole_pre_validators = field.whole_pre_validators # type: ignore\n new_field.whole_post_validators = field.whole_post_validators # type: ignore\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n try:\n new_field.populate_validators()\n except AttributeError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n new_field._populate_validators() # type: ignore\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\ntry:\n from pydantic.fields import FieldInfo, ModelField, UndefinedType\n\n PYDANTIC_1 = True\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n\n class UndefinedType: # type: ignore\n def __repr__(self) -> str:\n return \"PydanticUndefined\"\n\n logger.warning(\n \"Pydantic versions < 1.0.0 are deprecated in FastAPI and support will be \"\n \"removed soon.\"\n )\n PYDANTIC_1 = False\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef get_field_info(field: ModelField) -> FieldInfo:\n if PYDANTIC_1:\n return field.field_info # type: ignore\n else:\n return field.schema # type: ignore # pragma: nocover\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef warning_response_model_skip_defaults_deprecated() -> None:\n logger.warning( # pragma: nocover\n \"response_model_skip_defaults has been deprecated in favor of \"\n \"response_model_exclude_unset to keep in line with Pydantic v1, support for \"\n \"it will be removed soon.\"\n )\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n # ignore mypy error until enum schemas are released\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n if PYDANTIC_1:\n return response_field(field_info=field_info)\n else: # pragma: nocover\n return response_field(schema=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__ # type: ignore\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n if PYDANTIC_1:\n new_field.field_info = field.field_info\n else: # pragma: nocover\n new_field.schema = field.schema # type: ignore\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n if PYDANTIC_1:\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n else: # pragma: nocover\n new_field.whole_pre_validators = field.whole_pre_validators # type: ignore\n new_field.whole_post_validators = field.whole_post_validators # type: ignore\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n try:\n new_field.populate_validators()\n except AttributeError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n new_field._populate_validators() # type: ignore\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: dict, update_dict: dict) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n________________ ERROR collecting tests/test_computed_fields.py ________________\nImportError while importing test module '/workspace/test_repo/tests/test_computed_fields.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_computed_fields.py:2: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_computed_fields.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 2, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_computed_fields.py"}}},{"rowIdx":54,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__is_body_allowed_for_status_code__c43120258fa89bc20d6f8ee671b6ead9ab223fc7"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"c43120258fa89bc20d6f8ee671b6ead9ab223fc7"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"is_body_allowed_for_status_code"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 304})\n"},"gold_code":{"kind":"string","value":"def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 304})\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo()\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_datetime_custom_encoder.py ____________\nImportError while importing test module '/workspace/test_repo/tests/test_datetime_custom_encoder.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_datetime_custom_encoder.py:3: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_datetime_custom_encoder.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_datetime_custom_encoder.py"}}},{"rowIdx":55,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__get_path_param_names__b9d912c6380661647b51c322820fcb4ba08f32d2"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b9d912c6380661647b51c322820fcb4ba08f32d2"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_path_param_names"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n"},"gold_code":{"kind":"string","value":"def get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Dict, Sequence, Set, Type\n\nfrom starlette.routing import BaseRoute\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseModel\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]):\n body_fields_from_routes = []\n responses_from_routes = []\n for route in routes:\n if route.include_in_schema and isinstance(route, routing.APIRoute):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n):\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Dict, Sequence, Set, Type\n\nfrom starlette.routing import BaseRoute\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseModel\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]):\n body_fields_from_routes = []\n responses_from_routes = []\n for route in routes:\n if route.include_in_schema and isinstance(route, routing.APIRoute):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n):\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_datetime_custom_encoder.py ____________\nImportError while importing test module '/workspace/test_repo/tests/test_datetime_custom_encoder.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_datetime_custom_encoder.py:3: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_datetime_custom_encoder.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_datetime_custom_encoder.py"}}},{"rowIdx":56,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__create_cloned_field__aa84ac8e3e305d76e71c0c1b31237517948fa12f"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"aa84ac8e3e305d76e71c0c1b31237517948fa12f"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"create_cloned_field"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"gold_code":{"kind":"string","value":"def create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(\n routes: Sequence[Type[BaseRoute]]\n) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n default = None,\n required = False,\n model_config = BaseConfig,\n schema = Schema(None),\n )\n new_field.has_alias= field.has_alias\n new_field.alias= field.alias\n new_field.class_validators= field.class_validators\n new_field.default= field.default\n new_field.required= field.required\n new_field.model_config= field.model_config\n new_field.schema= field.schema\n new_field.allow_none= field.allow_none\n new_field.validate_always= field.validate_always\n if field.sub_fields:\n new_field.sub_fields= [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(\n routes: Sequence[Type[BaseRoute]]\n) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_datetime_custom_encoder.py ____________\ntests/test_datetime_custom_encoder.py:3: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nfastapi/utils.py:109: in <module>\n def create_cloned_field(field: Field) -> Field:\nE NameError: name 'Field' is not defined\n=========================== short test summary info ============================\nERROR tests/test_datetime_custom_encoder.py - NameError: name 'Field' is not ...\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_datetime_custom_encoder.py"}}},{"rowIdx":57,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__generate_operation_id_for_path__687065509b047a642acd1d281d6d68c6698509b1"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"687065509b047a642acd1d281d6d68c6698509b1"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"generate_operation_id_for_path"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"gold_code":{"kind":"string","value":"def generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_datetime_custom_encoder.py ____________\nImportError while importing test module '/workspace/test_repo/tests/test_datetime_custom_encoder.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_datetime_custom_encoder.py:3: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_datetime_custom_encoder.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_datetime_custom_encoder.py"}}},{"rowIdx":58,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__generate_unique_id__8a0d4c79c18e6bd219b965b9d50578c139e7efd8"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"8a0d4c79c18e6bd219b965b9d50578c139e7efd8"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"generate_unique_id"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n"},"gold_code":{"kind":"string","value":"def generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_datetime_custom_encoder.py ____________\nImportError while importing test module '/workspace/test_repo/tests/test_datetime_custom_encoder.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_datetime_custom_encoder.py:3: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_datetime_custom_encoder.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_datetime_custom_encoder.py"}}},{"rowIdx":59,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__deep_dict_update__181a32236a32305788b87d10e7990d9564ae2056"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"181a32236a32305788b87d10e7990d9564ae2056"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"deep_dict_update"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def deep_dict_update(main_dict: dict, update_dict: dict) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n"},"gold_code":{"kind":"string","value":"def deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\ntry:\n from pydantic.fields import FieldInfo, ModelField, UndefinedType\n\n PYDANTIC_1 = True\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n\n class UndefinedType: # type: ignore\n def __repr__(self) -> str:\n return \"PydanticUndefined\"\n\n logger.warning(\n \"Pydantic versions < 1.0.0 are deprecated in FastAPI and support will be \"\n \"removed soon.\"\n )\n PYDANTIC_1 = False\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef get_field_info(field: ModelField) -> FieldInfo:\n if PYDANTIC_1:\n return field.field_info # type: ignore\n else:\n return field.schema # type: ignore # pragma: nocover\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef warning_response_model_skip_defaults_deprecated() -> None:\n logger.warning( # pragma: nocover\n \"response_model_skip_defaults has been deprecated in favor of \"\n \"response_model_exclude_unset to keep in line with Pydantic v1, support for \"\n \"it will be removed soon.\"\n )\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n # ignore mypy error until enum schemas are released\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n if PYDANTIC_1:\n return response_field(field_info=field_info)\n else: # pragma: nocover\n return response_field(schema=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__ # type: ignore\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n if PYDANTIC_1:\n new_field.field_info = field.field_info\n else: # pragma: nocover\n new_field.schema = field.schema # type: ignore\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n if PYDANTIC_1:\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n else: # pragma: nocover\n new_field.whole_pre_validators = field.whole_pre_validators # type: ignore\n new_field.whole_post_validators = field.whole_post_validators # type: ignore\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n try:\n new_field.populate_validators()\n except AttributeError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n new_field._populate_validators() # type: ignore\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\ntry:\n from pydantic.fields import FieldInfo, ModelField, UndefinedType\n\n PYDANTIC_1 = True\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n\n class UndefinedType: # type: ignore\n def __repr__(self) -> str:\n return \"PydanticUndefined\"\n\n logger.warning(\n \"Pydantic versions < 1.0.0 are deprecated in FastAPI and support will be \"\n \"removed soon.\"\n )\n PYDANTIC_1 = False\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef get_field_info(field: ModelField) -> FieldInfo:\n if PYDANTIC_1:\n return field.field_info # type: ignore\n else:\n return field.schema # type: ignore # pragma: nocover\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef warning_response_model_skip_defaults_deprecated() -> None:\n logger.warning( # pragma: nocover\n \"response_model_skip_defaults has been deprecated in favor of \"\n \"response_model_exclude_unset to keep in line with Pydantic v1, support for \"\n \"it will be removed soon.\"\n )\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n # ignore mypy error until enum schemas are released\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n if PYDANTIC_1:\n return response_field(field_info=field_info)\n else: # pragma: nocover\n return response_field(schema=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__ # type: ignore\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n if PYDANTIC_1:\n new_field.field_info = field.field_info\n else: # pragma: nocover\n new_field.schema = field.schema # type: ignore\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n if PYDANTIC_1:\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n else: # pragma: nocover\n new_field.whole_pre_validators = field.whole_pre_validators # type: ignore\n new_field.whole_post_validators = field.whole_post_validators # type: ignore\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n try:\n new_field.populate_validators()\n except AttributeError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n new_field._populate_validators() # type: ignore\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: dict, update_dict: dict) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_datetime_custom_encoder.py ____________\nImportError while importing test module '/workspace/test_repo/tests/test_datetime_custom_encoder.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_datetime_custom_encoder.py:3: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_datetime_custom_encoder.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_datetime_custom_encoder.py"}}},{"rowIdx":60,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee___compat__get_schema_from_model_field__0976185af96ab2ee39c949c0456be616b01f8669"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"0976185af96ab2ee39c949c0456be616b01f8669"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_schema_from_model_field"},"pyfile_name":{"kind":"string","value":"_compat.py"},"original_code":{"kind":"string","value":"def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\n \"title\"\n ] = field.field_info.title or field.alias.title().replace(\"_\", \" \")\n return json_schema\n"},"gold_code":{"kind":"string","value":"def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n) -> Dict[str, Any]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, override_mode or field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\"title\"] = (\n field.field_info.title or field.alias.title().replace(\"_\", \" \")\n )\n return json_schema\n"},"old_filtered_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as PYDANTIC_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import MultiHostUrl as MultiHostUrl\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n from pydantic_core.core_schema import (\n general_plain_validator_function as general_plain_validator_function,\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def general_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"old_complete_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as PYDANTIC_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import MultiHostUrl as MultiHostUrl\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n from pydantic_core.core_schema import (\n general_plain_validator_function as general_plain_validator_function,\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\n \"title\"\n ] = field.field_info.title or field.alias.title().replace(\"_\", \" \")\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n inputs = [\n (field, field.mode, field._type_adapter.core_schema) for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions # type: ignore[return-value]\n\n def is_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n return field_annotation_is_scalar(\n field.field_info.annotation\n ) and not isinstance(field.field_info, params.Body)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_sequence(field.field_info.annotation)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_scalar_sequence(field.field_info.annotation)\n\n def is_bytes_field(field: ModelField) -> bool:\n return is_bytes_or_nonable_bytes_annotation(field.type_)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return is_bytes_sequence_annotation(field.type_)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return type(field_info).from_annotation(annotation)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n origin_type = (\n get_origin(\n field.field_info.annotation) or field.field_info.annotation\n )\n # type: ignore[arg-type]\n assert issubclass(origin_type, sequence_types)\n # type: ignore[no-any-return]\n return sequence_annotation_to_type[origin_type](value)\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n error = ValidationError.from_exception_data(\n \"Field required\", [{\"type\": \"missing\", \"loc\": loc, \"input\": {}}]\n ).errors()[0]\n error[\"input\"] = None\n return error # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n field_params = {\n f.name: (f.field_info.annotation, f.field_info) for f in fields}\n BodyModel: Type[BaseModel] = create_model(\n model_name, **field_params) # type: ignore[call-overload]\n return BodyModel\n\nelse:\n from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX\n from pydantic import AnyUrl as Url # noqa: F401\n from pydantic import ( # type: ignore[assignment]\n BaseConfig as BaseConfig, # noqa: F401\n )\n from pydantic import ValidationError as ValidationError # noqa: F401\n from pydantic.class_validators import ( # type: ignore[no-redef]\n Validator as Validator, # noqa: F401\n )\n from pydantic.error_wrappers import ( # type: ignore[no-redef]\n ErrorWrapper as ErrorWrapper, # noqa: F401\n )\n from pydantic.errors import MissingError\n from pydantic.fields import ( # type: ignore[attr-defined]\n SHAPE_FROZENSET,\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n )\n from pydantic.fields import FieldInfo as FieldInfo\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n ModelField as ModelField, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Required as Required, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Undefined as Undefined,\n )\n from pydantic.fields import ( # type: ignore[no-redef, attr-defined]\n UndefinedType as UndefinedType, # noqa: F401\n )\n from pydantic.networks import ( # type: ignore[no-redef]\n MultiHostDsn as MultiHostUrl, # noqa: F401\n )\n from pydantic.schema import (\n field_schema,\n get_flat_models_from_fields,\n get_model_name_map,\n model_process_schema,\n )\n from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401\n get_annotation_from_field_info as get_annotation_from_field_info,\n )\n from pydantic.typing import ( # type: ignore[no-redef]\n evaluate_forwardref as evaluate_forwardref, # noqa: F401\n )\n from pydantic.utils import ( # type: ignore[no-redef]\n lenient_issubclass as lenient_issubclass, # noqa: F401\n )\n\n GetJsonSchemaHandler = Any # type: ignore[assignment,misc]\n JsonSchemaValue = Dict[str, Any] # type: ignore[misc]\n CoreSchema = Any # type: ignore[assignment,misc]\n\n sequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_FROZENSET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n }\n sequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n }\n\n @dataclass\n class GenerateJsonSchema: # type: ignore[no-redef]\n ref_template: str\n\n class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]\n pass\n\n def general_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n models = get_flat_models_from_fields(fields, known_models=set())\n return {}, get_model_definitions(\n flat_models=models, model_name_map=model_name_map\n )\n\n def is_scalar_field(field: ModelField) -> bool:\n return is_pv1_scalar_field(field)\n\n def is_sequence_field(field: ModelField) -> bool:\n # type: ignore[attr-defined]\n return field.shape in sequence_shapes or _annotation_is_sequence(field.type_)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return is_pv1_scalar_sequence_field(field)\n\n def is_bytes_field(field: ModelField) -> bool:\n return lenient_issubclass(field.type_, bytes)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n # type: ignore[attr-defined]\n return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return copy(field_info)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n # type: ignore[no-any-return,attr-defined]\n return sequence_shape_to_type[field.shape](value)\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n missing_field_error = ErrorWrapper(\n MissingError(), loc=loc) # type: ignore[call-arg]\n new_error = ValidationError([missing_field_error], RequestErrorModel)\n return new_error.errors()[0] # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n BodyModel = create_model(model_name)\n for f in fields:\n BodyModel.__fields__[f.name] = f # type: ignore[index]\n return BodyModel\n\n\ndef _regenerate_error_with_loc(\n *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]\n) -> List[Dict[str, Any]]:\n updated_loc_errors: List[Any] = [\n {**err, \"loc\": loc_prefix + err.get(\"loc\", ())}\n for err in _normalize_errors(errors)\n ]\n\n return updated_loc_errors\n\n\ndef _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n if lenient_issubclass(annotation, (str, bytes)):\n return False\n return lenient_issubclass(annotation, sequence_types)\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"new_filtered_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as P_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\n# Reassign variable to make it reexported for mypy\nPYDANTIC_VERSION = P_VERSION\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n\n try:\n from pydantic_core.core_schema import (\n with_info_plain_validator_function as with_info_plain_validator_function,\n )\n except ImportError: # pragma: no cover\n from pydantic_core.core_schema import (\n general_plain_validator_function as with_info_plain_validator_function, # noqa: F401\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(include_url=False), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def with_info_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if field_annotation_is_sequence(arg):\n return True\n return False\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"new_complete_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as P_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\n# Reassign variable to make it reexported for mypy\nPYDANTIC_VERSION = P_VERSION\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n\n try:\n from pydantic_core.core_schema import (\n with_info_plain_validator_function as with_info_plain_validator_function,\n )\n except ImportError: # pragma: no cover\n from pydantic_core.core_schema import (\n general_plain_validator_function as with_info_plain_validator_function, # noqa: F401\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(include_url=False), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, override_mode or field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\"title\"] = (\n field.field_info.title or field.alias.title().replace(\"_\", \" \")\n )\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n inputs = [\n (field, override_mode or field.mode, field._type_adapter.core_schema)\n for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions # type: ignore[return-value]\n\n def is_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n return field_annotation_is_scalar(\n field.field_info.annotation\n ) and not isinstance(field.field_info, params.Body)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_sequence(field.field_info.annotation)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_scalar_sequence(field.field_info.annotation)\n\n def is_bytes_field(field: ModelField) -> bool:\n return is_bytes_or_nonable_bytes_annotation(field.type_)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return is_bytes_sequence_annotation(field.type_)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n cls = type(field_info)\n merged_field_info = cls.from_annotation(annotation)\n new_field_info = copy(field_info)\n new_field_info.metadata = merged_field_info.metadata\n new_field_info.annotation = merged_field_info.annotation\n return new_field_info\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n origin_type = (\n get_origin(field.field_info.annotation) or field.field_info.annotation\n )\n assert issubclass(origin_type, sequence_types) # type: ignore[arg-type]\n return sequence_annotation_to_type[origin_type](value) # type: ignore[no-any-return]\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n error = ValidationError.from_exception_data(\n \"Field required\", [{\"type\": \"missing\", \"loc\": loc, \"input\": {}}]\n ).errors(include_url=False)[0]\n error[\"input\"] = None\n return error # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n field_params = {f.name: (f.field_info.annotation, f.field_info) for f in fields}\n BodyModel: Type[BaseModel] = create_model(model_name, **field_params) # type: ignore[call-overload]\n return BodyModel\n\n def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:\n return [\n ModelField(field_info=field_info, name=name)\n for name, field_info in model.model_fields.items()\n ]\n\nelse:\n from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX\n from pydantic import AnyUrl as Url # noqa: F401\n from pydantic import ( # type: ignore[assignment]\n BaseConfig as BaseConfig, # noqa: F401\n )\n from pydantic import ValidationError as ValidationError # noqa: F401\n from pydantic.class_validators import ( # type: ignore[no-redef]\n Validator as Validator, # noqa: F401\n )\n from pydantic.error_wrappers import ( # type: ignore[no-redef]\n ErrorWrapper as ErrorWrapper, # noqa: F401\n )\n from pydantic.errors import MissingError\n from pydantic.fields import ( # type: ignore[attr-defined]\n SHAPE_FROZENSET,\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n )\n from pydantic.fields import FieldInfo as FieldInfo\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n ModelField as ModelField, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Required as Required, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Undefined as Undefined,\n )\n from pydantic.fields import ( # type: ignore[no-redef, attr-defined]\n UndefinedType as UndefinedType, # noqa: F401\n )\n from pydantic.schema import (\n field_schema,\n get_flat_models_from_fields,\n get_model_name_map,\n model_process_schema,\n )\n from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401\n get_annotation_from_field_info as get_annotation_from_field_info,\n )\n from pydantic.typing import ( # type: ignore[no-redef]\n evaluate_forwardref as evaluate_forwardref, # noqa: F401\n )\n from pydantic.utils import ( # type: ignore[no-redef]\n lenient_issubclass as lenient_issubclass, # noqa: F401\n )\n\n GetJsonSchemaHandler = Any # type: ignore[assignment,misc]\n JsonSchemaValue = Dict[str, Any] # type: ignore[misc]\n CoreSchema = Any # type: ignore[assignment,misc]\n\n sequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_FROZENSET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n }\n sequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n }\n\n @dataclass\n class GenerateJsonSchema: # type: ignore[no-redef]\n ref_template: str\n\n class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]\n pass\n\n def with_info_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n for sub_field in field.sub_fields: # type: ignore[attr-defined]\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n models = get_flat_models_from_fields(fields, known_models=set())\n return {}, get_model_definitions(\n flat_models=models, model_name_map=model_name_map\n )\n\n def is_scalar_field(field: ModelField) -> bool:\n return is_pv1_scalar_field(field)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field.shape in sequence_shapes or _annotation_is_sequence(field.type_) # type: ignore[attr-defined]\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return is_pv1_scalar_sequence_field(field)\n\n def is_bytes_field(field: ModelField) -> bool:\n return lenient_issubclass(field.type_, bytes)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes) # type: ignore[attr-defined]\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return copy(field_info)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n return sequence_shape_to_type[field.shape](value) # type: ignore[no-any-return,attr-defined]\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n missing_field_error = ErrorWrapper(MissingError(), loc=loc) # type: ignore[call-arg]\n new_error = ValidationError([missing_field_error], RequestErrorModel)\n return new_error.errors()[0] # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n BodyModel = create_model(model_name)\n for f in fields:\n BodyModel.__fields__[f.name] = f # type: ignore[index]\n return BodyModel\n\n def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:\n return list(model.__fields__.values()) # type: ignore[attr-defined]\n\n\ndef _regenerate_error_with_loc(\n *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]\n) -> List[Dict[str, Any]]:\n updated_loc_errors: List[Any] = [\n {**err, \"loc\": loc_prefix + err.get(\"loc\", ())}\n for err in _normalize_errors(errors)\n ]\n\n return updated_loc_errors\n\n\ndef _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n if lenient_issubclass(annotation, (str, bytes)):\n return False\n return lenient_issubclass(annotation, sequence_types)\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if field_annotation_is_sequence(arg):\n return True\n return False\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes)) # type: ignore[arg-type]\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 2 items\n\ntests/test_custom_schema_fields.py::test_custom_response_schema FAILED [ 50%]\ntests/test_custom_schema_fields.py::test_response PASSED [100%]\n\n=================================== FAILURES ===================================\n_________________________ test_custom_response_schema __________________________\n\n def test_custom_response_schema():\n> response = client.get(\"/openapi.json\")\n\ntests/test_custom_schema_fields.py:51: \n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:551: in get\n return super().get(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:1041: in get\n return self.request(\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:519: in request\n return super().request(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:814: in request\n return self.send(request, auth=auth, follow_redirects=follow_redirects)\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:901: in send\n response = self._send_handling_auth(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:929: in _send_handling_auth\n response = self._send_handling_redirects(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:966: in _send_handling_redirects\n response = self._send_single_request(request)\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:1002: in _send_single_request\n response = transport.handle_request(request)\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:401: in handle_request\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:398: in handle_request\n portal.call(self.app, scope, receive, send)\n../test_venv/lib/python3.11/site-packages/anyio/from_thread.py:277: in call\n return cast(T_Retval, self.start_task_soon(func, *args).result())\n/usr/local/lib/python3.11/concurrent/futures/_base.py:456: in result\n return self.__get_result()\n/usr/local/lib/python3.11/concurrent/futures/_base.py:401: in __get_result\n raise self._exception\n../test_venv/lib/python3.11/site-packages/anyio/from_thread.py:217: in _call_func\n retval = await retval\nfastapi/applications.py:1054: in __call__\n await super().__call__(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/applications.py:123: in __call__\n await self.middleware_stack(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/middleware/errors.py:186: in __call__\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/middleware/errors.py:164: in __call__\n await self.app(scope, receive, _send)\n../test_venv/lib/python3.11/site-packages/starlette/middleware/exceptions.py:65: in __call__\n await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:64: in wrapped_app\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:53: in wrapped_app\n await app(scope, receive, sender)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:754: in __call__\n await self.middleware_stack(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:774: in app\n await route.handle(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:295: in handle\n await self.app(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:77: in app\n await wrap_app_handling_exceptions(app, request)(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:64: in wrapped_app\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:53: in wrapped_app\n await app(scope, receive, sender)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:74: in app\n response = await f(request)\nfastapi/applications.py:1009: in openapi\n return JSONResponse(self.openapi())\nfastapi/applications.py:981: in openapi\n self.openapi_schema = get_openapi(\nfastapi/openapi/utils.py:483: in get_openapi\n result = get_openapi_path(\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n\n def get_openapi_path(\n *,\n route: routing.APIRoute,\n operation_ids: Set[str],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Tuple[Dict[str, Any], Dict[str, Any], Dict[str, Any]]:\n path = {}\n security_schemes: Dict[str, Any] = {}\n definitions: Dict[str, Any] = {}\n assert route.methods is not None, \"Methods must be a list\"\n if isinstance(route.response_class, DefaultPlaceholder):\n current_response_class: Type[Response] = route.response_class.value\n else:\n current_response_class = route.response_class\n assert current_response_class, \"A response class is needed to generate OpenAPI\"\n route_response_media_type: Optional[str] = current_response_class.media_type\n if route.include_in_schema:\n for method in route.methods:\n operation = get_openapi_operation_metadata(\n route=route, method=method, operation_ids=operation_ids\n )\n parameters: List[Dict[str, Any]] = []\n flat_dependant = get_flat_dependant(route.dependant, skip_repeats=True)\n security_definitions, operation_security = get_openapi_security_definitions(\n flat_dependant=flat_dependant\n )\n if operation_security:\n operation.setdefault(\"security\", []).extend(operation_security)\n if security_definitions:\n security_schemes.update(security_definitions)\n all_route_params = get_flat_params(route.dependant)\n operation_parameters = get_openapi_operation_parameters(\n all_route_params=all_route_params,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n field_mapping=field_mapping,\n separate_input_output_schemas=separate_input_output_schemas,\n )\n parameters.extend(operation_parameters)\n if parameters:\n all_parameters = {\n (param[\"in\"], param[\"name\"]): param for param in parameters\n }\n required_parameters = {\n (param[\"in\"], param[\"name\"]): param\n for param in parameters\n if param.get(\"required\")\n }\n # Make sure required definitions of the same parameter take precedence\n # over non-required definitions\n all_parameters.update(required_parameters)\n operation[\"parameters\"] = list(all_parameters.values())\n if method in METHODS_WITH_BODY:\n request_body_oai = get_openapi_operation_request_body(\n body_field=route.body_field,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n field_mapping=field_mapping,\n separate_input_output_schemas=separate_input_output_schemas,\n )\n if request_body_oai:\n operation[\"requestBody\"] = request_body_oai\n if route.callbacks:\n callbacks = {}\n for callback in route.callbacks:\n if isinstance(callback, routing.APIRoute):\n (\n cb_path,\n cb_security_schemes,\n cb_definitions,\n ) = get_openapi_path(\n route=callback,\n operation_ids=operation_ids,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n field_mapping=field_mapping,\n separate_input_output_schemas=separate_input_output_schemas,\n )\n callbacks[callback.name] = {callback.path: cb_path}\n operation[\"callbacks\"] = callbacks\n if route.status_code is not None:\n status_code = str(route.status_code)\n else:\n # It would probably make more sense for all response classes to have an\n # explicit default status_code, and to extract it from them, instead of\n # doing this inspection tricks, that would probably be in the future\n # TODO: probably make status_code a default class attribute for all\n # responses in Starlette\n response_signature = inspect.signature(current_response_class.__init__)\n status_code_param = response_signature.parameters.get(\"status_code\")\n if status_code_param is not None:\n if isinstance(status_code_param.default, int):\n status_code = str(status_code_param.default)\n operation.setdefault(\"responses\", {}).setdefault(status_code, {})[\n \"description\"\n ] = route.response_description\n if route_response_media_type and is_body_allowed_for_status_code(\n route.status_code\n ):\n response_schema = {\"type\": \"string\"}\n if lenient_issubclass(current_response_class, JSONResponse):\n if route.response_field:\n> response_schema = get_schema_from_model_field(\n field=route.response_field,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n field_mapping=field_mapping,\n separate_input_output_schemas=separate_input_output_schemas,\n )\nE TypeError: get_schema_from_model_field() got an unexpected keyword argument 'separate_input_output_schemas'\n\nfastapi/openapi/utils.py:322: TypeError\n=========================== short test summary info ============================\nFAILED tests/test_custom_schema_fields.py::test_custom_response_schema - Type...\n========================= 1 failed, 1 passed in 0.86s ==========================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 2, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 1, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/_compat.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_schema_fields.py"}}},{"rowIdx":61,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee___compat__get_definitions__0976185af96ab2ee39c949c0456be616b01f8669"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"0976185af96ab2ee39c949c0456be616b01f8669"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_definitions"},"pyfile_name":{"kind":"string","value":"_compat.py"},"original_code":{"kind":"string","value":"def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n]:\n inputs = [\n (field, field.mode, field._type_adapter.core_schema) for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions\n"},"gold_code":{"kind":"string","value":"def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n inputs = [\n (field, override_mode or field.mode, field._type_adapter.core_schema)\n for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions\n"},"old_filtered_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as PYDANTIC_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import MultiHostUrl as MultiHostUrl\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n from pydantic_core.core_schema import (\n general_plain_validator_function as general_plain_validator_function,\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\n \"title\"\n ] = field.field_info.title or field.alias.title().replace(\"_\", \" \")\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def general_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"old_complete_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as PYDANTIC_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import MultiHostUrl as MultiHostUrl\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n from pydantic_core.core_schema import (\n general_plain_validator_function as general_plain_validator_function,\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\n \"title\"\n ] = field.field_info.title or field.alias.title().replace(\"_\", \" \")\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n inputs = [\n (field, field.mode, field._type_adapter.core_schema) for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions # type: ignore[return-value]\n\n def is_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n return field_annotation_is_scalar(\n field.field_info.annotation\n ) and not isinstance(field.field_info, params.Body)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_sequence(field.field_info.annotation)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_scalar_sequence(field.field_info.annotation)\n\n def is_bytes_field(field: ModelField) -> bool:\n return is_bytes_or_nonable_bytes_annotation(field.type_)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return is_bytes_sequence_annotation(field.type_)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return type(field_info).from_annotation(annotation)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n origin_type = (\n get_origin(\n field.field_info.annotation) or field.field_info.annotation\n )\n # type: ignore[arg-type]\n assert issubclass(origin_type, sequence_types)\n # type: ignore[no-any-return]\n return sequence_annotation_to_type[origin_type](value)\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n error = ValidationError.from_exception_data(\n \"Field required\", [{\"type\": \"missing\", \"loc\": loc, \"input\": {}}]\n ).errors()[0]\n error[\"input\"] = None\n return error # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n field_params = {\n f.name: (f.field_info.annotation, f.field_info) for f in fields}\n BodyModel: Type[BaseModel] = create_model(\n model_name, **field_params) # type: ignore[call-overload]\n return BodyModel\n\nelse:\n from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX\n from pydantic import AnyUrl as Url # noqa: F401\n from pydantic import ( # type: ignore[assignment]\n BaseConfig as BaseConfig, # noqa: F401\n )\n from pydantic import ValidationError as ValidationError # noqa: F401\n from pydantic.class_validators import ( # type: ignore[no-redef]\n Validator as Validator, # noqa: F401\n )\n from pydantic.error_wrappers import ( # type: ignore[no-redef]\n ErrorWrapper as ErrorWrapper, # noqa: F401\n )\n from pydantic.errors import MissingError\n from pydantic.fields import ( # type: ignore[attr-defined]\n SHAPE_FROZENSET,\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n )\n from pydantic.fields import FieldInfo as FieldInfo\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n ModelField as ModelField, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Required as Required, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Undefined as Undefined,\n )\n from pydantic.fields import ( # type: ignore[no-redef, attr-defined]\n UndefinedType as UndefinedType, # noqa: F401\n )\n from pydantic.networks import ( # type: ignore[no-redef]\n MultiHostDsn as MultiHostUrl, # noqa: F401\n )\n from pydantic.schema import (\n field_schema,\n get_flat_models_from_fields,\n get_model_name_map,\n model_process_schema,\n )\n from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401\n get_annotation_from_field_info as get_annotation_from_field_info,\n )\n from pydantic.typing import ( # type: ignore[no-redef]\n evaluate_forwardref as evaluate_forwardref, # noqa: F401\n )\n from pydantic.utils import ( # type: ignore[no-redef]\n lenient_issubclass as lenient_issubclass, # noqa: F401\n )\n\n GetJsonSchemaHandler = Any # type: ignore[assignment,misc]\n JsonSchemaValue = Dict[str, Any] # type: ignore[misc]\n CoreSchema = Any # type: ignore[assignment,misc]\n\n sequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_FROZENSET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n }\n sequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n }\n\n @dataclass\n class GenerateJsonSchema: # type: ignore[no-redef]\n ref_template: str\n\n class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]\n pass\n\n def general_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n models = get_flat_models_from_fields(fields, known_models=set())\n return {}, get_model_definitions(\n flat_models=models, model_name_map=model_name_map\n )\n\n def is_scalar_field(field: ModelField) -> bool:\n return is_pv1_scalar_field(field)\n\n def is_sequence_field(field: ModelField) -> bool:\n # type: ignore[attr-defined]\n return field.shape in sequence_shapes or _annotation_is_sequence(field.type_)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return is_pv1_scalar_sequence_field(field)\n\n def is_bytes_field(field: ModelField) -> bool:\n return lenient_issubclass(field.type_, bytes)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n # type: ignore[attr-defined]\n return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return copy(field_info)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n # type: ignore[no-any-return,attr-defined]\n return sequence_shape_to_type[field.shape](value)\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n missing_field_error = ErrorWrapper(\n MissingError(), loc=loc) # type: ignore[call-arg]\n new_error = ValidationError([missing_field_error], RequestErrorModel)\n return new_error.errors()[0] # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n BodyModel = create_model(model_name)\n for f in fields:\n BodyModel.__fields__[f.name] = f # type: ignore[index]\n return BodyModel\n\n\ndef _regenerate_error_with_loc(\n *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]\n) -> List[Dict[str, Any]]:\n updated_loc_errors: List[Any] = [\n {**err, \"loc\": loc_prefix + err.get(\"loc\", ())}\n for err in _normalize_errors(errors)\n ]\n\n return updated_loc_errors\n\n\ndef _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n if lenient_issubclass(annotation, (str, bytes)):\n return False\n return lenient_issubclass(annotation, sequence_types)\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"new_filtered_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as P_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\n# Reassign variable to make it reexported for mypy\nPYDANTIC_VERSION = P_VERSION\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n\n try:\n from pydantic_core.core_schema import (\n with_info_plain_validator_function as with_info_plain_validator_function,\n )\n except ImportError: # pragma: no cover\n from pydantic_core.core_schema import (\n general_plain_validator_function as with_info_plain_validator_function, # noqa: F401\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(include_url=False), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, override_mode or field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\"title\"] = (\n field.field_info.title or field.alias.title().replace(\"_\", \" \")\n )\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def with_info_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if field_annotation_is_sequence(arg):\n return True\n return False\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"new_complete_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as P_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\n# Reassign variable to make it reexported for mypy\nPYDANTIC_VERSION = P_VERSION\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n\n try:\n from pydantic_core.core_schema import (\n with_info_plain_validator_function as with_info_plain_validator_function,\n )\n except ImportError: # pragma: no cover\n from pydantic_core.core_schema import (\n general_plain_validator_function as with_info_plain_validator_function, # noqa: F401\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(include_url=False), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, override_mode or field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\"title\"] = (\n field.field_info.title or field.alias.title().replace(\"_\", \" \")\n )\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n inputs = [\n (field, override_mode or field.mode, field._type_adapter.core_schema)\n for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions # type: ignore[return-value]\n\n def is_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n return field_annotation_is_scalar(\n field.field_info.annotation\n ) and not isinstance(field.field_info, params.Body)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_sequence(field.field_info.annotation)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_scalar_sequence(field.field_info.annotation)\n\n def is_bytes_field(field: ModelField) -> bool:\n return is_bytes_or_nonable_bytes_annotation(field.type_)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return is_bytes_sequence_annotation(field.type_)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n cls = type(field_info)\n merged_field_info = cls.from_annotation(annotation)\n new_field_info = copy(field_info)\n new_field_info.metadata = merged_field_info.metadata\n new_field_info.annotation = merged_field_info.annotation\n return new_field_info\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n origin_type = (\n get_origin(field.field_info.annotation) or field.field_info.annotation\n )\n assert issubclass(origin_type, sequence_types) # type: ignore[arg-type]\n return sequence_annotation_to_type[origin_type](value) # type: ignore[no-any-return]\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n error = ValidationError.from_exception_data(\n \"Field required\", [{\"type\": \"missing\", \"loc\": loc, \"input\": {}}]\n ).errors(include_url=False)[0]\n error[\"input\"] = None\n return error # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n field_params = {f.name: (f.field_info.annotation, f.field_info) for f in fields}\n BodyModel: Type[BaseModel] = create_model(model_name, **field_params) # type: ignore[call-overload]\n return BodyModel\n\n def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:\n return [\n ModelField(field_info=field_info, name=name)\n for name, field_info in model.model_fields.items()\n ]\n\nelse:\n from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX\n from pydantic import AnyUrl as Url # noqa: F401\n from pydantic import ( # type: ignore[assignment]\n BaseConfig as BaseConfig, # noqa: F401\n )\n from pydantic import ValidationError as ValidationError # noqa: F401\n from pydantic.class_validators import ( # type: ignore[no-redef]\n Validator as Validator, # noqa: F401\n )\n from pydantic.error_wrappers import ( # type: ignore[no-redef]\n ErrorWrapper as ErrorWrapper, # noqa: F401\n )\n from pydantic.errors import MissingError\n from pydantic.fields import ( # type: ignore[attr-defined]\n SHAPE_FROZENSET,\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n )\n from pydantic.fields import FieldInfo as FieldInfo\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n ModelField as ModelField, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Required as Required, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Undefined as Undefined,\n )\n from pydantic.fields import ( # type: ignore[no-redef, attr-defined]\n UndefinedType as UndefinedType, # noqa: F401\n )\n from pydantic.schema import (\n field_schema,\n get_flat_models_from_fields,\n get_model_name_map,\n model_process_schema,\n )\n from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401\n get_annotation_from_field_info as get_annotation_from_field_info,\n )\n from pydantic.typing import ( # type: ignore[no-redef]\n evaluate_forwardref as evaluate_forwardref, # noqa: F401\n )\n from pydantic.utils import ( # type: ignore[no-redef]\n lenient_issubclass as lenient_issubclass, # noqa: F401\n )\n\n GetJsonSchemaHandler = Any # type: ignore[assignment,misc]\n JsonSchemaValue = Dict[str, Any] # type: ignore[misc]\n CoreSchema = Any # type: ignore[assignment,misc]\n\n sequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_FROZENSET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n }\n sequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n }\n\n @dataclass\n class GenerateJsonSchema: # type: ignore[no-redef]\n ref_template: str\n\n class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]\n pass\n\n def with_info_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n for sub_field in field.sub_fields: # type: ignore[attr-defined]\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n models = get_flat_models_from_fields(fields, known_models=set())\n return {}, get_model_definitions(\n flat_models=models, model_name_map=model_name_map\n )\n\n def is_scalar_field(field: ModelField) -> bool:\n return is_pv1_scalar_field(field)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field.shape in sequence_shapes or _annotation_is_sequence(field.type_) # type: ignore[attr-defined]\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return is_pv1_scalar_sequence_field(field)\n\n def is_bytes_field(field: ModelField) -> bool:\n return lenient_issubclass(field.type_, bytes)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes) # type: ignore[attr-defined]\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return copy(field_info)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n return sequence_shape_to_type[field.shape](value) # type: ignore[no-any-return,attr-defined]\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n missing_field_error = ErrorWrapper(MissingError(), loc=loc) # type: ignore[call-arg]\n new_error = ValidationError([missing_field_error], RequestErrorModel)\n return new_error.errors()[0] # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n BodyModel = create_model(model_name)\n for f in fields:\n BodyModel.__fields__[f.name] = f # type: ignore[index]\n return BodyModel\n\n def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:\n return list(model.__fields__.values()) # type: ignore[attr-defined]\n\n\ndef _regenerate_error_with_loc(\n *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]\n) -> List[Dict[str, Any]]:\n updated_loc_errors: List[Any] = [\n {**err, \"loc\": loc_prefix + err.get(\"loc\", ())}\n for err in _normalize_errors(errors)\n ]\n\n return updated_loc_errors\n\n\ndef _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n if lenient_issubclass(annotation, (str, bytes)):\n return False\n return lenient_issubclass(annotation, sequence_types)\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if field_annotation_is_sequence(arg):\n return True\n return False\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes)) # type: ignore[arg-type]\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 2 items\n\ntests/test_custom_schema_fields.py::test_custom_response_schema FAILED [ 50%]\ntests/test_custom_schema_fields.py::test_response PASSED [100%]\n\n=================================== FAILURES ===================================\n_________________________ test_custom_response_schema __________________________\n\n def test_custom_response_schema():\n> response = client.get(\"/openapi.json\")\n\ntests/test_custom_schema_fields.py:51: \n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:551: in get\n return super().get(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:1041: in get\n return self.request(\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:519: in request\n return super().request(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:814: in request\n return self.send(request, auth=auth, follow_redirects=follow_redirects)\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:901: in send\n response = self._send_handling_auth(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:929: in _send_handling_auth\n response = self._send_handling_redirects(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:966: in _send_handling_redirects\n response = self._send_single_request(request)\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:1002: in _send_single_request\n response = transport.handle_request(request)\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:401: in handle_request\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:398: in handle_request\n portal.call(self.app, scope, receive, send)\n../test_venv/lib/python3.11/site-packages/anyio/from_thread.py:277: in call\n return cast(T_Retval, self.start_task_soon(func, *args).result())\n/usr/local/lib/python3.11/concurrent/futures/_base.py:456: in result\n return self.__get_result()\n/usr/local/lib/python3.11/concurrent/futures/_base.py:401: in __get_result\n raise self._exception\n../test_venv/lib/python3.11/site-packages/anyio/from_thread.py:217: in _call_func\n retval = await retval\nfastapi/applications.py:1054: in __call__\n await super().__call__(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/applications.py:123: in __call__\n await self.middleware_stack(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/middleware/errors.py:186: in __call__\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/middleware/errors.py:164: in __call__\n await self.app(scope, receive, _send)\n../test_venv/lib/python3.11/site-packages/starlette/middleware/exceptions.py:65: in __call__\n await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:64: in wrapped_app\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:53: in wrapped_app\n await app(scope, receive, sender)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:754: in __call__\n await self.middleware_stack(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:774: in app\n await route.handle(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:295: in handle\n await self.app(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:77: in app\n await wrap_app_handling_exceptions(app, request)(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:64: in wrapped_app\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:53: in wrapped_app\n await app(scope, receive, sender)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:74: in app\n response = await f(request)\nfastapi/applications.py:1009: in openapi\n return JSONResponse(self.openapi())\nfastapi/applications.py:981: in openapi\n self.openapi_schema = get_openapi(\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n\n def get_openapi(\n *,\n title: str,\n version: str,\n openapi_version: str = \"3.1.0\",\n summary: Optional[str] = None,\n description: Optional[str] = None,\n routes: Sequence[BaseRoute],\n webhooks: Optional[Sequence[BaseRoute]] = None,\n tags: Optional[List[Dict[str, Any]]] = None,\n servers: Optional[List[Dict[str, Union[str, Any]]]] = None,\n terms_of_service: Optional[str] = None,\n contact: Optional[Dict[str, Union[str, Any]]] = None,\n license_info: Optional[Dict[str, Union[str, Any]]] = None,\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n info: Dict[str, Any] = {\"title\": title, \"version\": version}\n if summary:\n info[\"summary\"] = summary\n if description:\n info[\"description\"] = description\n if terms_of_service:\n info[\"termsOfService\"] = terms_of_service\n if contact:\n info[\"contact\"] = contact\n if license_info:\n info[\"license\"] = license_info\n output: Dict[str, Any] = {\"openapi\": openapi_version, \"info\": info}\n if servers:\n output[\"servers\"] = servers\n components: Dict[str, Dict[str, Any]] = {}\n paths: Dict[str, Dict[str, Any]] = {}\n webhook_paths: Dict[str, Dict[str, Any]] = {}\n operation_ids: Set[str] = set()\n all_fields = get_fields_from_routes(list(routes or []) + list(webhooks or []))\n model_name_map = get_compat_model_name_map(all_fields)\n schema_generator = GenerateJsonSchema(ref_template=REF_TEMPLATE)\n> field_mapping, definitions = get_definitions(\n fields=all_fields,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n separate_input_output_schemas=separate_input_output_schemas,\n )\nE TypeError: get_definitions() got an unexpected keyword argument 'separate_input_output_schemas'\n\nfastapi/openapi/utils.py:475: TypeError\n=========================== short test summary info ============================\nFAILED tests/test_custom_schema_fields.py::test_custom_response_schema - Type...\n========================= 1 failed, 1 passed in 0.85s ==========================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 2, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 1, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/_compat.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_schema_fields.py"}}},{"rowIdx":62,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing___prepare_response_content__aea04ee32ee1942e6e1a904527bb8da6ba76abd9"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"aea04ee32ee1942e6e1a904527bb8da6ba76abd9"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"_prepare_response_content"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def _prepare_response_content(\n res: Any, *, by_alias: bool = True, exclude_unset: bool\n) -> Any:\n if isinstance(res, BaseModel):\n if PYDANTIC_1:\n return res.dict(by_alias=by_alias, exclude_unset=exclude_unset)\n else:\n return res.dict(\n by_alias=by_alias, skip_defaults=exclude_unset\n ) # pragma: nocover\n elif isinstance(res, list):\n return [\n _prepare_response_content(item, exclude_unset=exclude_unset) for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(v, exclude_unset=exclude_unset)\n for k, v in res.items()\n }\n return res\n"},"gold_code":{"kind":"string","value":"def _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Set, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import STATUS_CODES_WITH_NO_BODY\nfrom fastapi.utils import (\n PYDANTIC_1,\n create_cloned_field,\n create_response_field,\n generate_operation_id_for_path,\n get_field_info,\n warning_response_model_skip_defaults_deprecated,\n)\nfrom pydantic import BaseModel\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import Mount # noqa\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp\nfrom starlette.websockets import WebSocket\n\ntry:\n from pydantic.fields import FieldInfo, ModelField\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic import Schema as FieldInfo # type: ignore\n from pydantic.fields import Field as ModelField # type: ignore\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: ModelField = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: ModelField = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n dependency_overrides_provider: Any = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n get_field_info(body_field), params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logger.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors, body=body)\n else:\n raw_response = await run_endpoint_function(\n dependant=dependant, values=values, is_coroutine=is_coroutine\n )\n\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n is_coroutine=is_coroutine,\n )\n response = response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Any = None\n) -> Callable:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n name: str = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Optional[Type[Response]] = None,\n dependency_overrides_provider: Any = None,\n callbacks: Optional[List[\"APIRoute\"]] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods = set([method.upper() for method in methods])\n self.unique_id = generate_operation_id_for_path(\n name=self.name, path=self.path_format, method=list(methods)[0]\n )\n self.response_model = response_model\n if self.response_model:\n assert (\n status_code not in STATUS_CODES_WITH_NO_BODY\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_response_field(\n name=response_name, type_=self.response_model\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[\n ModelField\n ] = create_cloned_field(self.response_field)\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.status_code = status_code\n self.tags = tags or []\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0]\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert (\n additional_status_code not in STATUS_CODES_WITH_NO_BODY\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_response_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n assert callable(endpoint), f\"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class or JSONResponse,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n routes: List[routing.BaseRoute] = None,\n redirect_slashes: bool = True,\n default: ASGIApp = None,\n dependency_overrides_provider: Any = None,\n route_class: Type[APIRoute] = APIRoute,\n default_response_class: Type[Response] = None,\n on_startup: Sequence[Callable] = None,\n on_shutdown: Sequence[Callable] = None,\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n )\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: List[APIRoute] = None,\n ) -> None:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n route_class = route_class_override or self.route_class\n route = route_class(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=callbacks,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n default_response_class: Optional[Type[Response]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\")\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=list(dependencies or [])\n + list(route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class or default_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=route.callbacks,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=list(route.methods or []),\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Set, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import STATUS_CODES_WITH_NO_BODY\nfrom fastapi.utils import (\n PYDANTIC_1,\n create_cloned_field,\n create_response_field,\n generate_operation_id_for_path,\n get_field_info,\n warning_response_model_skip_defaults_deprecated,\n)\nfrom pydantic import BaseModel\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import Mount # noqa\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp\nfrom starlette.websockets import WebSocket\n\ntry:\n from pydantic.fields import FieldInfo, ModelField\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic import Schema as FieldInfo # type: ignore\n from pydantic.fields import Field as ModelField # type: ignore\n\n\ndef _prepare_response_content(\n res: Any, *, by_alias: bool = True, exclude_unset: bool\n) -> Any:\n if isinstance(res, BaseModel):\n if PYDANTIC_1:\n return res.dict(by_alias=by_alias, exclude_unset=exclude_unset)\n else:\n return res.dict(\n by_alias=by_alias, skip_defaults=exclude_unset\n ) # pragma: nocover\n elif isinstance(res, list):\n return [\n _prepare_response_content(item, exclude_unset=exclude_unset) for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(v, exclude_unset=exclude_unset)\n for k, v in res.items()\n }\n return res\n\n\nasync def serialize_response(\n *,\n field: ModelField = None,\n response_content: Any,\n include: Union[SetIntStr, DictIntStrAny] = None,\n exclude: Union[SetIntStr, DictIntStrAny] = set(),\n by_alias: bool = True,\n exclude_unset: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n response_content = _prepare_response_content(\n response_content, by_alias=by_alias, exclude_unset=exclude_unset\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors, field.type_)\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: ModelField = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: ModelField = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n dependency_overrides_provider: Any = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n get_field_info(body_field), params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logger.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors, body=body)\n else:\n raw_response = await run_endpoint_function(\n dependant=dependant, values=values, is_coroutine=is_coroutine\n )\n\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n is_coroutine=is_coroutine,\n )\n response = response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Any = None\n) -> Callable:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n name: str = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Optional[Type[Response]] = None,\n dependency_overrides_provider: Any = None,\n callbacks: Optional[List[\"APIRoute\"]] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods = set([method.upper() for method in methods])\n self.unique_id = generate_operation_id_for_path(\n name=self.name, path=self.path_format, method=list(methods)[0]\n )\n self.response_model = response_model\n if self.response_model:\n assert (\n status_code not in STATUS_CODES_WITH_NO_BODY\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_response_field(\n name=response_name, type_=self.response_model\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[\n ModelField\n ] = create_cloned_field(self.response_field)\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.status_code = status_code\n self.tags = tags or []\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0]\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert (\n additional_status_code not in STATUS_CODES_WITH_NO_BODY\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_response_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n assert callable(endpoint), f\"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class or JSONResponse,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n routes: List[routing.BaseRoute] = None,\n redirect_slashes: bool = True,\n default: ASGIApp = None,\n dependency_overrides_provider: Any = None,\n route_class: Type[APIRoute] = APIRoute,\n default_response_class: Type[Response] = None,\n on_startup: Sequence[Callable] = None,\n on_shutdown: Sequence[Callable] = None,\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n )\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: List[APIRoute] = None,\n ) -> None:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n route_class = route_class_override or self.route_class\n route = route_class(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=callbacks,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n default_response_class: Optional[Type[Response]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\")\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=list(dependencies or [])\n + list(route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class or default_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=route.callbacks,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=list(route.methods or []),\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":63,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__get_request_handler__8c3ef76139590e0478e799375ec4c41703ea9f77"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"8c3ef76139590e0478e799375ec4c41703ea9f77"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_request_handler"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def get_request_handler(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n dependency_overrides_provider: Any = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors)\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field,\n response=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n skip_defaults=response_model_skip_defaults,\n )\n response = response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n return response\n\n return app\n"},"gold_code":{"kind":"string","value":"def get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Set, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.utils import create_cloned_field, generate_operation_id_for_path\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(\n *,\n field: Field = None,\n response: Response,\n include: Union[SetIntStr, DictIntStrAny] = None,\n exclude: Union[SetIntStr, DictIntStrAny] = set(),\n by_alias: bool = True,\n skip_defaults: bool = False,\n) -> Any:\n if field:\n errors = []\n if skip_defaults and isinstance(response, BaseModel):\n response = response.dict(skip_defaults=skip_defaults)\n value, errors_ = field.validate(response, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors, field.type_)\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n skip_defaults=skip_defaults,\n )\n else:\n return jsonable_encoder(response)\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Any = None\n) -> Callable:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n name: str = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Optional[Type[Response]] = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods = set([method.upper() for method in methods])\n self.unique_id = generate_operation_id_for_path(\n name=self.name, path=self.path_format, method=list(methods)[0]\n )\n self.response_model = response_model\n if self.response_model:\n response_name = \"Response_\" + self.unique_id\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[Field] = create_cloned_field(\n self.response_field\n )\n else:\n self.response_field = None\n self.secure_cloned_response_field = None\n self.status_code = status_code\n self.tags = tags or []\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0]\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_skip_defaults = response_model_skip_defaults\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.dependency_overrides_provider = dependency_overrides_provider\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class or JSONResponse,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_skip_defaults=self.response_model_skip_defaults,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n routes: List[routing.BaseRoute] = None,\n redirect_slashes: bool = True,\n default: ASGIApp = None,\n dependency_overrides_provider: Any = None,\n route_class: Type[APIRoute] = APIRoute,\n ) -> None:\n super().__init__(\n routes=routes, redirect_slashes=redirect_slashes, default=default\n )\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n ) -> None:\n route_class = route_class_override or self.route_class\n route = route_class(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n default_response_class: Optional[Type[Response]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\")\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=list(dependencies or [])\n + list(route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_skip_defaults=route.response_model_skip_defaults,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class or default_response_class,\n name=route.name,\n route_class_override=type(route),\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=list(route.methods or []),\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Set, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.utils import create_cloned_field, generate_operation_id_for_path\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(\n *,\n field: Field = None,\n response: Response,\n include: Union[SetIntStr, DictIntStrAny] = None,\n exclude: Union[SetIntStr, DictIntStrAny] = set(),\n by_alias: bool = True,\n skip_defaults: bool = False,\n) -> Any:\n if field:\n errors = []\n if skip_defaults and isinstance(response, BaseModel):\n response = response.dict(skip_defaults=skip_defaults)\n value, errors_ = field.validate(response, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors, field.type_)\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n skip_defaults=skip_defaults,\n )\n else:\n return jsonable_encoder(response)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n dependency_overrides_provider: Any = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors)\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field,\n response=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n skip_defaults=response_model_skip_defaults,\n )\n response = response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Any = None\n) -> Callable:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n name: str = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Optional[Type[Response]] = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods = set([method.upper() for method in methods])\n self.unique_id = generate_operation_id_for_path(\n name=self.name, path=self.path_format, method=list(methods)[0]\n )\n self.response_model = response_model\n if self.response_model:\n response_name = \"Response_\" + self.unique_id\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[Field] = create_cloned_field(\n self.response_field\n )\n else:\n self.response_field = None\n self.secure_cloned_response_field = None\n self.status_code = status_code\n self.tags = tags or []\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0]\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_skip_defaults = response_model_skip_defaults\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.dependency_overrides_provider = dependency_overrides_provider\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class or JSONResponse,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_skip_defaults=self.response_model_skip_defaults,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n routes: List[routing.BaseRoute] = None,\n redirect_slashes: bool = True,\n default: ASGIApp = None,\n dependency_overrides_provider: Any = None,\n route_class: Type[APIRoute] = APIRoute,\n ) -> None:\n super().__init__(\n routes=routes, redirect_slashes=redirect_slashes, default=default\n )\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n ) -> None:\n route_class = route_class_override or self.route_class\n route = route_class(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n default_response_class: Optional[Type[Response]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\")\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=list(dependencies or [])\n + list(route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_skip_defaults=route.response_model_skip_defaults,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class or default_response_class,\n name=route.name,\n route_class_override=type(route),\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=list(route.methods or []),\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":64,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__get_websocket_app__b087246f2649e1b30545693d7b850e5f277c3a29"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b087246f2649e1b30545693d7b850e5f277c3a29"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_websocket_app"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def get_websocket_app(dependant: Dependant) -> Callable:\n async def app(websocket: WebSocket) -> None:\n values, errors, _ = await solve_dependencies(\n request=websocket, dependant=dependant\n )\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n assert dependant.call is not None, \"dependant.call must me a function\"\n await dependant.call(**values)\n\n return app\n"},"gold_code":{"kind":"string","value":"def get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nimport re\nfrom typing import Any, Callable, Dict, List, Optional, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY, WS_1008_POLICY_VIOLATION\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(*, field: Field = None, response: Response) -> Any:\n encoded = jsonable_encoder(response)\n if field:\n errors = []\n value, errors_ = field.validate(encoded, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors)\n return jsonable_encoder(value)\n else:\n return encoded\n\n\ndef get_app(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n values, errors, background_tasks = await solve_dependencies(\n request=request, dependant=dependant, body=body\n )\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field, response=raw_response\n )\n return response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n\n return app\n\n def __init__(self, path: str, endpoint: Callable, *, name: str = None) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(dependant=self.dependant))\n regex = \"^\" + path + \"$\"\n regex = re.sub(\"{([a-zA-Z_][a-zA-Z0-9_]*)}\", r\"(?P<\\1>[^/]+)\", regex)\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n ) -> None:\n assert path.startswith(\"/\"), \"Routed paths must always start with '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.response_model = response_model\n if self.response_model:\n assert lenient_issubclass(\n response_class, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n response_name = \"Response_\" + self.name\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n else:\n self.response_field = None\n self.status_code = status_code\n self.tags = tags or []\n self.dependencies = dependencies or []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.name}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.operation_id = operation_id\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(path=path, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0, get_parameterless_sub_dependant(depends=depends, path=path)\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.name)\n self.app = request_response(\n get_app(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.response_field,\n )\n )\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=(dependencies or []) +\n (route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class,\n name=route.name,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=route.methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nimport re\nfrom typing import Any, Callable, Dict, List, Optional, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY, WS_1008_POLICY_VIOLATION\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(*, field: Field = None, response: Response) -> Any:\n encoded = jsonable_encoder(response)\n if field:\n errors = []\n value, errors_ = field.validate(encoded, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors)\n return jsonable_encoder(value)\n else:\n return encoded\n\n\ndef get_app(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n values, errors, background_tasks = await solve_dependencies(\n request=request, dependant=dependant, body=body\n )\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field, response=raw_response\n )\n return response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n\n return app\n\n\ndef get_websocket_app(dependant: Dependant) -> Callable:\n async def app(websocket: WebSocket) -> None:\n values, errors, _ = await solve_dependencies(\n request=websocket, dependant=dependant\n )\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n assert dependant.call is not None, \"dependant.call must me a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(self, path: str, endpoint: Callable, *, name: str = None) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(dependant=self.dependant))\n regex = \"^\" + path + \"$\"\n regex = re.sub(\"{([a-zA-Z_][a-zA-Z0-9_]*)}\", r\"(?P<\\1>[^/]+)\", regex)\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n ) -> None:\n assert path.startswith(\"/\"), \"Routed paths must always start with '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.response_model = response_model\n if self.response_model:\n assert lenient_issubclass(\n response_class, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n response_name = \"Response_\" + self.name\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n else:\n self.response_field = None\n self.status_code = status_code\n self.tags = tags or []\n self.dependencies = dependencies or []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.name}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.operation_id = operation_id\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(path=path, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0, get_parameterless_sub_dependant(depends=depends, path=path)\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.name)\n self.app = request_response(\n get_app(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.response_field,\n )\n )\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=(dependencies or []) +\n (route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class,\n name=route.name,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=route.methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":65,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__decorator__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"decorator"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n"},"gold_code":{"kind":"string","value":"def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":66,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__get_route_handler__8c3ef76139590e0478e799375ec4c41703ea9f77"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"8c3ef76139590e0478e799375ec4c41703ea9f77"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"get_route_handler"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def get_route_handler(self) -> Callable:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class or JSONResponse,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_skip_defaults=self.response_model_skip_defaults,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n"},"gold_code":{"kind":"string","value":"def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Set, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.utils import create_cloned_field, generate_operation_id_for_path\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(\n *,\n field: Field = None,\n response: Response,\n include: Union[SetIntStr, DictIntStrAny] = None,\n exclude: Union[SetIntStr, DictIntStrAny] = set(),\n by_alias: bool = True,\n skip_defaults: bool = False,\n) -> Any:\n if field:\n errors = []\n if skip_defaults and isinstance(response, BaseModel):\n response = response.dict(skip_defaults=skip_defaults)\n value, errors_ = field.validate(response, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors, field.type_)\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n skip_defaults=skip_defaults,\n )\n else:\n return jsonable_encoder(response)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n dependency_overrides_provider: Any = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors)\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field,\n response=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n skip_defaults=response_model_skip_defaults,\n )\n response = response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Any = None\n) -> Callable:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n name: str = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Optional[Type[Response]] = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods = set([method.upper() for method in methods])\n self.unique_id = generate_operation_id_for_path(\n name=self.name, path=self.path_format, method=list(methods)[0]\n )\n self.response_model = response_model\n if self.response_model:\n response_name = \"Response_\" + self.unique_id\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[Field] = create_cloned_field(\n self.response_field\n )\n else:\n self.response_field = None\n self.secure_cloned_response_field = None\n self.status_code = status_code\n self.tags = tags or []\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0]\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_skip_defaults = response_model_skip_defaults\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.dependency_overrides_provider = dependency_overrides_provider\n self.app = request_response(self.get_route_handler())\n\n def __init__(\n self,\n routes: List[routing.BaseRoute] = None,\n redirect_slashes: bool = True,\n default: ASGIApp = None,\n dependency_overrides_provider: Any = None,\n route_class: Type[APIRoute] = APIRoute,\n ) -> None:\n super().__init__(\n routes=routes, redirect_slashes=redirect_slashes, default=default\n )\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n ) -> None:\n route_class = route_class_override or self.route_class\n route = route_class(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n default_response_class: Optional[Type[Response]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\")\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=list(dependencies or [])\n + list(route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_skip_defaults=route.response_model_skip_defaults,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class or default_response_class,\n name=route.name,\n route_class_override=type(route),\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=list(route.methods or []),\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Set, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.utils import create_cloned_field, generate_operation_id_for_path\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(\n *,\n field: Field = None,\n response: Response,\n include: Union[SetIntStr, DictIntStrAny] = None,\n exclude: Union[SetIntStr, DictIntStrAny] = set(),\n by_alias: bool = True,\n skip_defaults: bool = False,\n) -> Any:\n if field:\n errors = []\n if skip_defaults and isinstance(response, BaseModel):\n response = response.dict(skip_defaults=skip_defaults)\n value, errors_ = field.validate(response, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors, field.type_)\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n skip_defaults=skip_defaults,\n )\n else:\n return jsonable_encoder(response)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n dependency_overrides_provider: Any = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors)\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field,\n response=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n skip_defaults=response_model_skip_defaults,\n )\n response = response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Any = None\n) -> Callable:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n name: str = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Optional[Type[Response]] = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods = set([method.upper() for method in methods])\n self.unique_id = generate_operation_id_for_path(\n name=self.name, path=self.path_format, method=list(methods)[0]\n )\n self.response_model = response_model\n if self.response_model:\n response_name = \"Response_\" + self.unique_id\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[Field] = create_cloned_field(\n self.response_field\n )\n else:\n self.response_field = None\n self.secure_cloned_response_field = None\n self.status_code = status_code\n self.tags = tags or []\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0]\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_skip_defaults = response_model_skip_defaults\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.dependency_overrides_provider = dependency_overrides_provider\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class or JSONResponse,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_skip_defaults=self.response_model_skip_defaults,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n routes: List[routing.BaseRoute] = None,\n redirect_slashes: bool = True,\n default: ASGIApp = None,\n dependency_overrides_provider: Any = None,\n route_class: Type[APIRoute] = APIRoute,\n ) -> None:\n super().__init__(\n routes=routes, redirect_slashes=redirect_slashes, default=default\n )\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n ) -> None:\n route_class = route_class_override or self.route_class\n route = route_class(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n default_response_class: Optional[Type[Response]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\")\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=list(dependencies or [])\n + list(route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_skip_defaults=route.response_model_skip_defaults,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class or default_response_class,\n name=route.name,\n route_class_override=type(route),\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=list(route.methods or []),\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_skip_defaults=response_model_skip_defaults,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":67,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__add_api_route__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"add_api_route"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n"},"gold_code":{"kind":"string","value":"def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":68,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__api_route__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"api_route"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n"},"gold_code":{"kind":"string","value":"def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":69,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__add_api_websocket_route__b087246f2649e1b30545693d7b850e5f277c3a29"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b087246f2649e1b30545693d7b850e5f277c3a29"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"add_api_websocket_route"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n"},"gold_code":{"kind":"string","value":"def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nimport re\nfrom typing import Any, Callable, Dict, List, Optional, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY, WS_1008_POLICY_VIOLATION\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(*, field: Field = None, response: Response) -> Any:\n encoded = jsonable_encoder(response)\n if field:\n errors = []\n value, errors_ = field.validate(encoded, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors)\n return jsonable_encoder(value)\n else:\n return encoded\n\n\ndef get_app(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n values, errors, background_tasks = await solve_dependencies(\n request=request, dependant=dependant, body=body\n )\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field, response=raw_response\n )\n return response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n\n return app\n\n\ndef get_websocket_app(dependant: Dependant) -> Callable:\n async def app(websocket: WebSocket) -> None:\n values, errors, _ = await solve_dependencies(\n request=websocket, dependant=dependant\n )\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n assert dependant.call is not None, \"dependant.call must me a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(self, path: str, endpoint: Callable, *, name: str = None) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(dependant=self.dependant))\n regex = \"^\" + path + \"$\"\n regex = re.sub(\"{([a-zA-Z_][a-zA-Z0-9_]*)}\", r\"(?P<\\1>[^/]+)\", regex)\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n ) -> None:\n assert path.startswith(\"/\"), \"Routed paths must always start with '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.response_model = response_model\n if self.response_model:\n assert lenient_issubclass(\n response_class, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n response_name = \"Response_\" + self.name\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n else:\n self.response_field = None\n self.status_code = status_code\n self.tags = tags or []\n self.dependencies = dependencies or []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.name}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.operation_id = operation_id\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(path=path, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0, get_parameterless_sub_dependant(depends=depends, path=path)\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.name)\n self.app = request_response(\n get_app(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.response_field,\n )\n )\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nimport re\nfrom typing import Any, Callable, Dict, List, Optional, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY, WS_1008_POLICY_VIOLATION\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(*, field: Field = None, response: Response) -> Any:\n encoded = jsonable_encoder(response)\n if field:\n errors = []\n value, errors_ = field.validate(encoded, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors)\n return jsonable_encoder(value)\n else:\n return encoded\n\n\ndef get_app(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n values, errors, background_tasks = await solve_dependencies(\n request=request, dependant=dependant, body=body\n )\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field, response=raw_response\n )\n return response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n\n return app\n\n\ndef get_websocket_app(dependant: Dependant) -> Callable:\n async def app(websocket: WebSocket) -> None:\n values, errors, _ = await solve_dependencies(\n request=websocket, dependant=dependant\n )\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n assert dependant.call is not None, \"dependant.call must me a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(self, path: str, endpoint: Callable, *, name: str = None) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(dependant=self.dependant))\n regex = \"^\" + path + \"$\"\n regex = re.sub(\"{([a-zA-Z_][a-zA-Z0-9_]*)}\", r\"(?P<\\1>[^/]+)\", regex)\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n ) -> None:\n assert path.startswith(\"/\"), \"Routed paths must always start with '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.response_model = response_model\n if self.response_model:\n assert lenient_issubclass(\n response_class, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n response_name = \"Response_\" + self.name\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n else:\n self.response_field = None\n self.status_code = status_code\n self.tags = tags or []\n self.dependencies = dependencies or []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.name}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.operation_id = operation_id\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(path=path, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0, get_parameterless_sub_dependant(depends=depends, path=path)\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.name)\n self.app = request_response(\n get_app(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.response_field,\n )\n )\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=(dependencies or []) +\n (route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class,\n name=route.name,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=route.methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":70,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__websocket__b087246f2649e1b30545693d7b850e5f277c3a29"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b087246f2649e1b30545693d7b850e5f277c3a29"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"websocket"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n"},"gold_code":{"kind":"string","value":"def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nimport re\nfrom typing import Any, Callable, Dict, List, Optional, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY, WS_1008_POLICY_VIOLATION\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(*, field: Field = None, response: Response) -> Any:\n encoded = jsonable_encoder(response)\n if field:\n errors = []\n value, errors_ = field.validate(encoded, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors)\n return jsonable_encoder(value)\n else:\n return encoded\n\n\ndef get_app(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n values, errors, background_tasks = await solve_dependencies(\n request=request, dependant=dependant, body=body\n )\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field, response=raw_response\n )\n return response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n\n return app\n\n\ndef get_websocket_app(dependant: Dependant) -> Callable:\n async def app(websocket: WebSocket) -> None:\n values, errors, _ = await solve_dependencies(\n request=websocket, dependant=dependant\n )\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n assert dependant.call is not None, \"dependant.call must me a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(self, path: str, endpoint: Callable, *, name: str = None) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(dependant=self.dependant))\n regex = \"^\" + path + \"$\"\n regex = re.sub(\"{([a-zA-Z_][a-zA-Z0-9_]*)}\", r\"(?P<\\1>[^/]+)\", regex)\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n ) -> None:\n assert path.startswith(\"/\"), \"Routed paths must always start with '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.response_model = response_model\n if self.response_model:\n assert lenient_issubclass(\n response_class, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n response_name = \"Response_\" + self.name\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n else:\n self.response_field = None\n self.status_code = status_code\n self.tags = tags or []\n self.dependencies = dependencies or []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.name}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.operation_id = operation_id\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(path=path, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0, get_parameterless_sub_dependant(depends=depends, path=path)\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.name)\n self.app = request_response(\n get_app(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.response_field,\n )\n )\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport logging\nimport re\nfrom typing import Any, Callable, Dict, List, Optional, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY, WS_1008_POLICY_VIOLATION\nfrom starlette.websockets import WebSocket\n\n\ndef serialize_response(*, field: Field = None, response: Response) -> Any:\n encoded = jsonable_encoder(response)\n if field:\n errors = []\n value, errors_ = field.validate(encoded, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors)\n return jsonable_encoder(value)\n else:\n return encoded\n\n\ndef get_app(\n dependant: Dependant,\n body_field: Field = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: Field = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logging.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n values, errors, background_tasks = await solve_dependencies(\n request=request, dependant=dependant, body=body\n )\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n assert dependant.call is not None, \"dependant.call must be a function\"\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = serialize_response(\n field=response_field, response=raw_response\n )\n return response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n\n return app\n\n\ndef get_websocket_app(dependant: Dependant) -> Callable:\n async def app(websocket: WebSocket) -> None:\n values, errors, _ = await solve_dependencies(\n request=websocket, dependant=dependant\n )\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n assert dependant.call is not None, \"dependant.call must me a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(self, path: str, endpoint: Callable, *, name: str = None) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(dependant=self.dependant))\n regex = \"^\" + path + \"$\"\n regex = re.sub(\"{([a-zA-Z_][a-zA-Z0-9_]*)}\", r\"(?P<\\1>[^/]+)\", regex)\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n ) -> None:\n assert path.startswith(\"/\"), \"Routed paths must always start with '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.response_model = response_model\n if self.response_model:\n assert lenient_issubclass(\n response_class, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n response_name = \"Response_\" + self.name\n self.response_field: Optional[Field] = Field(\n name=response_name,\n type_=self.response_model,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n else:\n self.response_field = None\n self.status_code = status_code\n self.tags = tags or []\n self.dependencies = dependencies or []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert lenient_issubclass(\n model, BaseModel\n ), \"A response model must be a Pydantic model\"\n response_name = f\"Response_{additional_status_code}_{self.name}\"\n response_field = Field(\n name=response_name,\n type_=model,\n class_validators=None,\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], Field] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.operation_id = operation_id\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n self.dependant = get_dependant(path=path, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0, get_parameterless_sub_dependant(depends=depends, path=path)\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.name)\n self.app = request_response(\n get_app(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.response_field,\n )\n )\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=(dependencies or []) +\n (route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class,\n name=route.name,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=route.methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[BaseModel] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: List[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n include_in_schema: bool = True,\n response_class: Type[Response] = JSONResponse,\n name: str = None,\n ) -> Callable:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies or [],\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":71,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__include_router__addfa89b0f750abc193f62be8e457fc487b842ee"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"addfa89b0f750abc193f62be8e457fc487b842ee"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"include_router"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def include_router(self, router: \"APIRouter\", *, prefix=\"\"):\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n for route in router.routes:\n if isinstance(route, APIRoute):\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n methods=route.methods,\n name=route.name,\n include_in_schema=route.include_in_schema,\n tags=route.tags,\n summary=route.summary,\n description=route.description,\n operation_id=route.operation_id,\n deprecated=route.deprecated,\n response_type=route.response_type,\n response_description=route.response_description,\n response_code=route.response_code,\n response_wrapper=route.response_wrapper,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=route.methods,\n name=route.name,\n include_in_schema=route.include_in_schema,\n )\n"},"gold_code":{"kind":"string","value":"def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom typing import Callable, List, Type\n\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\n\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.formparsers import UploadFile\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import get_name, request_response\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import get_body_field, get_dependant, solve_dependencies\nfrom fastapi.encoders import jsonable_encoder\n\n\ndef serialize_response(*, field: Field = None, response):\n if field:\n errors = []\n value, errors_ = field.validate(response, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors)\n return jsonable_encoder(value)\n else:\n return jsonable_encoder(response)\n\n\ndef get_app(\n dependant: Dependant,\n body_field: Field = None,\n response_code: str = 200,\n response_wrapper: Type[Response] = JSONResponse,\n response_field: Type[Field] = None,\n):\n is_coroutine = dependant.call and asyncio.iscoroutinefunction(\n dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n body = None\n if body_field:\n if is_body_form:\n raw_body = await request.form()\n body = {}\n for field, value in raw_body.items():\n if isinstance(value, UploadFile):\n body[field] = await value.read()\n else:\n body[field] = value\n else:\n body = await request.json()\n values, errors = await solve_dependencies(\n request=request, dependant=dependant, body=body\n )\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n if isinstance(raw_response, BaseModel):\n return response_wrapper(\n content=jsonable_encoder(raw_response), status_code=response_code\n )\n errors = []\n try:\n return response_wrapper(\n content=serialize_response(\n field=response_field, response=raw_response\n ),\n status_code=response_code,\n )\n except Exception as e:\n errors.append(e)\n try:\n response = dict(raw_response)\n return response_wrapper(\n content=serialize_response(\n field=response_field, response=response),\n status_code=response_code,\n )\n except Exception as e:\n errors.append(e)\n try:\n response = vars(raw_response)\n return response_wrapper(\n content=serialize_response(\n field=response_field, response=response),\n status_code=response_code,\n )\n except Exception as e:\n errors.append(e)\n raise ValueError(errors)\n\n return app\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n methods: List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n assert path.startswith(\"/\"), \"Routed paths must always start with '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags or []\n self.summary = summary\n self.description = description or self.endpoint.__doc__\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.body_field: Field = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.name)\n self.app = request_response(\n get_app(\n dependant=self.dependant,\n body_field=self.body_field,\n response_code=self.response_code,\n response_wrapper=self.response_wrapper,\n response_field=self.response_field,\n )\n )\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n methods: List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom typing import Callable, List, Type\n\nfrom pydantic import BaseConfig, BaseModel, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import Field\nfrom pydantic.utils import lenient_issubclass\n\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.formparsers import UploadFile\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import get_name, request_response\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import get_body_field, get_dependant, solve_dependencies\nfrom fastapi.encoders import jsonable_encoder\n\n\ndef serialize_response(*, field: Field = None, response):\n if field:\n errors = []\n value, errors_ = field.validate(response, {}, loc=(\"response\",))\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors)\n return jsonable_encoder(value)\n else:\n return jsonable_encoder(response)\n\n\ndef get_app(\n dependant: Dependant,\n body_field: Field = None,\n response_code: str = 200,\n response_wrapper: Type[Response] = JSONResponse,\n response_field: Type[Field] = None,\n):\n is_coroutine = dependant.call and asyncio.iscoroutinefunction(\n dependant.call)\n is_body_form = body_field and isinstance(body_field.schema, params.Form)\n\n async def app(request: Request) -> Response:\n body = None\n if body_field:\n if is_body_form:\n raw_body = await request.form()\n body = {}\n for field, value in raw_body.items():\n if isinstance(value, UploadFile):\n body[field] = await value.read()\n else:\n body[field] = value\n else:\n body = await request.json()\n values, errors = await solve_dependencies(\n request=request, dependant=dependant, body=body\n )\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n if isinstance(raw_response, BaseModel):\n return response_wrapper(\n content=jsonable_encoder(raw_response), status_code=response_code\n )\n errors = []\n try:\n return response_wrapper(\n content=serialize_response(\n field=response_field, response=raw_response\n ),\n status_code=response_code,\n )\n except Exception as e:\n errors.append(e)\n try:\n response = dict(raw_response)\n return response_wrapper(\n content=serialize_response(\n field=response_field, response=response),\n status_code=response_code,\n )\n except Exception as e:\n errors.append(e)\n try:\n response = vars(raw_response)\n return response_wrapper(\n content=serialize_response(\n field=response_field, response=response),\n status_code=response_code,\n )\n except Exception as e:\n errors.append(e)\n raise ValueError(errors)\n\n return app\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n methods: List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n assert path.startswith(\"/\"), \"Routed paths must always start with '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags or []\n self.summary = summary\n self.description = description or self.endpoint.__doc__\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.body_field: Field = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.name)\n self.app = request_response(\n get_app(\n dependant=self.dependant,\n body_field=self.body_field,\n response_code=self.response_code,\n response_wrapper=self.response_wrapper,\n response_field=self.response_field,\n )\n )\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n methods: List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def include_router(self, router: \"APIRouter\", *, prefix=\"\"):\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n for route in router.routes:\n if isinstance(route, APIRoute):\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n methods=route.methods,\n name=route.name,\n include_in_schema=route.include_in_schema,\n tags=route.tags,\n summary=route.summary,\n description=route.description,\n operation_id=route.operation_id,\n deprecated=route.deprecated,\n response_type=route.response_type,\n response_description=route.response_description,\n response_code=route.response_code,\n response_wrapper=route.response_wrapper,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=route.methods,\n name=route.name,\n include_in_schema=route.include_in_schema,\n )\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: List[str] = None,\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags or [],\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":72,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__get__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"get"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"gold_code":{"kind":"string","value":"def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":73,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__put__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"put"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"gold_code":{"kind":"string","value":"def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP POST operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP DELETE operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP OPTIONS operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP HEAD operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"]=\"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP PATCH operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP TRACE operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events /) .\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events/ # alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":74,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__post__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"post"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"gold_code":{"kind":"string","value":"def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP DELETE operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP OPTIONS operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP HEAD operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"]=\"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP PATCH operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP TRACE operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events /) .\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events/ # alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":75,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__delete__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"delete"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"gold_code":{"kind":"string","value":"def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":76,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__options__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"options"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"gold_code":{"kind":"string","value":"def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":77,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__head__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"head"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"gold_code":{"kind":"string","value":"def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP PATCH operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP TRACE operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events /) .\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events/ # alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":78,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__patch__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"patch"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"gold_code":{"kind":"string","value":"def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this * path operation*.\n\n For example, in `http: // example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic * field * type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/ docs`) will\n show it as the response(JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code(Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https: // fastapi.tiangolo.com/tutorial/response-model /) .\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https: // fastapi.tiangolo.com/tutorial/response-status-code /) .\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration / # tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies(using `Depends()`) to be applied to the\n * path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https: // fastapi.tiangolo.com/tutorial/dependencies/dependencies-in -path-operation-decorators /) .\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the * path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the * path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https: // fastapi.tiangolo.com/tutorial/path-operation-configuration /) .\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this * path operation*.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this * path operation * as deprecated.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this * path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class .\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler(less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https: // fastapi.tiangolo.com/tutorial/response-model / # response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this * path operation * in the generated OpenAPI schema.\n\n This affects the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https: // fastapi.tiangolo.com/tutorial/query-params-str-validations / # exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this * path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https: // fastapi.tiangolo.com/advanced/custom-response / # redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this * path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of * path operations * that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI(e.g. visible at `/ docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https: // fastapi.tiangolo.com/advanced/openapi-callbacks /) .\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this * path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https: // fastapi.tiangolo.com/advanced/path-operation-advanced-configuration / # custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the * path\n operations * shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https: // fastapi.tiangolo.com/advanced/generate-clients / # custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a * path operation * using an HTTP TRACE operation.\n\n # Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None=None\n\n app=FastAPI()\n router=APIRouter()\n\n @ router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events /) .\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events/ # alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":79,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__trace__406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"406c092a3bf65bbd4405ce87611a7e0b9c0ae706"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"trace"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"gold_code":{"kind":"string","value":"def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nimport re\nimport typing\nfrom copy import deepcopy\n\nfrom starlette import routing\nfrom starlette.routing import get_name, request_response\nfrom starlette.requests import Request\nfrom starlette.responses import Response, JSONResponse\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.status import HTTP_422_UNPROCESSABLE_ENTITY\n\n\nfrom pydantic.fields import Field, Required\nfrom pydantic.schema import get_annotation_from_schema\nfrom pydantic import BaseConfig, BaseModel, create_model, Schema\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.errors import MissingError\nfrom pydantic.utils import lenient_issubclass\nfrom .pydantic_utils import jsonable_encoder\n\nfrom fastapi import params\nfrom fastapi.security.base import SecurityBase\n\n\nparam_supported_types = (str, int, float, bool)\n\n\nclass Dependant:\n def __init__(\n self,\n *,\n path_params: typing.List[Field] = None,\n query_params: typing.List[Field] = None,\n header_params: typing.List[Field] = None,\n cookie_params: typing.List[Field] = None,\n body_params: typing.List[Field] = None,\n dependencies: typing.List[\"Dependant\"] = None,\n security_schemes: typing.List[Field] = None,\n name: str = None,\n call: typing.Callable = None,\n request_param_name: str = None,\n ) -> None:\n self.path_params: typing.List[Field] = path_params or []\n self.query_params: typing.List[Field] = query_params or []\n self.header_params: typing.List[Field] = header_params or []\n self.cookie_params: typing.List[Field] = cookie_params or []\n self.body_params: typing.List[Field] = body_params or []\n self.dependencies: typing.List[Dependant] = dependencies or []\n self.security_schemes: typing.List[Field] = security_schemes or []\n self.request_param_name = request_param_name\n self.name = name\n self.call: typing.Callable = call\n\n\ndef request_params_to_args(\n required_params: typing.List[Field], received_params: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n for field in required_params:\n value = received_params.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(MissingError(), loc=field.alias,\n config=BaseConfig)\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n v_, errors_ = field.validate(\n value, values, loc=(field.schema.in_.value, field.alias)\n )\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef request_body_to_args(\n required_params: typing.List[Field], received_body: typing.Dict[str, typing.Any]\n) -> typing.Tuple[typing.Dict[str, typing.Any], typing.List[ErrorWrapper]]:\n values = {}\n errors = []\n if required_params:\n field = required_params[0]\n sub_key = getattr(field.schema, \"sub_key\", None)\n if len(required_params) == 1 and not sub_key:\n received_body = {field.alias: received_body}\n for field in required_params:\n value = received_body.get(field.alias)\n if value is None:\n if field.required:\n errors.append(\n ErrorWrapper(\n MissingError(), loc=(\"body\", field.alias), config=BaseConfig\n )\n )\n else:\n values[field.name] = deepcopy(field.default)\n continue\n\n v_, errors_ = field.validate(\n value, values, loc=(\"body\", field.alias))\n if isinstance(errors_, ErrorWrapper):\n errors_: ErrorWrapper\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n else:\n values[field.name] = v_\n return values, errors\n\n\ndef add_param_to_fields(\n *,\n param: inspect.Parameter,\n dependant: Dependant,\n default_schema=params.Param,\n force_type: params.ParamTypes = None,\n):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, params.Param):\n schema = default_value\n default_value = schema.default\n if schema.in_ is None:\n schema.in_ = default_schema.in_\n if force_type:\n schema.in_ = force_type\n else:\n schema = default_schema(default_value)\n required = default_value == Required\n annotation = typing.Any\n if not param.annotation == param.empty:\n annotation = param.annotation\n annotation = get_annotation_from_schema(annotation, schema)\n Config = BaseConfig\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=Config,\n class_validators=[],\n schema=schema,\n )\n if schema.in_ == params.ParamTypes.path:\n dependant.path_params.append(field)\n elif schema.in_ == params.ParamTypes.query:\n dependant.query_params.append(field)\n elif schema.in_ == params.ParamTypes.header:\n dependant.header_params.append(field)\n else:\n assert (\n schema.in_ == params.ParamTypes.cookie\n ), f\"non-body parameters must be in path, query, header or cookie: {param.name}\"\n dependant.cookie_params.append(field)\n\n\ndef add_param_to_body_fields(*, param: inspect.Parameter, dependant: Dependant):\n default_value = Required\n if not param.default == param.empty:\n default_value = param.default\n if isinstance(default_value, Schema):\n schema = default_value\n default_value = schema.default\n else:\n schema = Schema(default_value)\n required = default_value == Required\n annotation = get_annotation_from_schema(param.annotation, schema)\n field = Field(\n name=param.name,\n type_=annotation,\n default=None if required else default_value,\n alias=schema.alias or param.name,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n schema=schema,\n )\n dependant.body_params.append(field)\n\n\ndef get_sub_dependant(\n *, param: inspect.Parameter, path: str\n):\n depends: params.Depends = param.default\n if depends.dependency:\n dependency = depends.dependency\n else:\n dependency = param.annotation\n assert callable(dependency)\n sub_dependant = get_dependant(path=path, call=dependency, name=param.name)\n if isinstance(dependency, SecurityBase):\n sub_dependant.security_schemes.append(dependency)\n return sub_dependant\n\n\ndef get_flat_dependant(dependant: Dependant):\n flat_dependant = Dependant(\n path_params=dependant.path_params.copy(),\n query_params=dependant.query_params.copy(),\n header_params=dependant.header_params.copy(),\n cookie_params=dependant.cookie_params.copy(),\n body_params=dependant.body_params.copy(),\n security_schemes=dependant.security_schemes.copy(),\n )\n for sub_dependant in dependant.dependencies:\n if sub_dependant is dependant:\n raise ValueError(\"recursion\", dependant.dependencies)\n flat_sub = get_flat_dependant(sub_dependant)\n flat_dependant.path_params.extend(flat_sub.path_params)\n flat_dependant.query_params.extend(flat_sub.query_params)\n flat_dependant.header_params.extend(flat_sub.header_params)\n flat_dependant.cookie_params.extend(flat_sub.cookie_params)\n flat_dependant.body_params.extend(flat_sub.body_params)\n flat_dependant.security_schemes.extend(flat_sub.security_schemes)\n return flat_dependant\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef get_dependant(*, path: str, call: typing.Callable, name: str = None):\n path_param_names = get_path_param_names(path)\n endpoint_signature = inspect.signature(call)\n signature_params = endpoint_signature.parameters\n dependant = Dependant(call=call, name=name)\n for param_name in signature_params:\n param = signature_params[param_name]\n if isinstance(param.default, params.Depends):\n sub_dependant = get_sub_dependant(param=param, path=path)\n dependant.dependencies.append(sub_dependant)\n for param_name in signature_params:\n param = signature_params[param_name]\n if (\n (param.default == param.empty) or isinstance(\n param.default, params.Path)\n ) and (param_name in path_param_names):\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Path params must be of type str, int, float or boot: {param}\"\n param = signature_params[param_name]\n add_param_to_fields(\n param=param,\n dependant=dependant,\n default_schema=params.Path,\n force_type=params.ParamTypes.path,\n )\n elif (param.default == param.empty or param.default is None) and (\n param.annotation == param.empty\n or lenient_issubclass(param.annotation, param_supported_types)\n ):\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif isinstance(param.default, params.Param):\n if param.annotation != param.empty:\n assert lenient_issubclass(\n param.annotation, param_supported_types\n ), f\"Parameters for Path, Query, Header and Cookies must be of type str, int, float or bool: {param}\"\n add_param_to_fields(\n param=param, dependant=dependant, default_schema=params.Query\n )\n elif lenient_issubclass(param.annotation, Request):\n dependant.request_param_name = param_name\n elif not isinstance(param.default, params.Depends):\n add_param_to_body_fields(param=param, dependant=dependant)\n return dependant\n\n\ndef is_coroutine_callable(call: typing.Callable):\n if inspect.isfunction(call):\n return asyncio.iscoroutinefunction(call)\n elif inspect.isclass(call):\n return False\n else:\n call = getattr(call, \"__call__\", None)\n if not call:\n return False\n else:\n return asyncio.iscoroutinefunction(call)\n\n\nasync def solve_dependencies(*, request: Request, dependant: Dependant):\n values = {}\n errors = []\n for sub_dependant in dependant.dependencies:\n sub_values, sub_errors = await solve_dependencies(\n request=request, dependant=sub_dependant\n )\n if sub_errors:\n return {}, errors\n if is_coroutine_callable(sub_dependant.call):\n solved = await sub_dependant.call(**sub_values)\n else:\n solved = await run_in_threadpool(sub_dependant.call, **sub_values)\n values[sub_dependant.name] = solved\n path_values, path_errors = request_params_to_args(\n dependant.path_params, request.path_params\n )\n query_values, query_errors = request_params_to_args(\n dependant.query_params, request.query_params\n )\n header_values, header_errors = request_params_to_args(\n dependant.header_params, request.headers\n )\n cookie_values, cookie_errors = request_params_to_args(\n dependant.cookie_params, request.cookies\n )\n values.update(path_values)\n values.update(query_values)\n values.update(header_values)\n values.update(cookie_values)\n errors = path_errors + query_errors + header_errors + cookie_errors\n if dependant.body_params:\n body = await request.json()\n body_values, body_errors = request_body_to_args(\n dependant.body_params, body)\n values.update(body_values)\n errors.extend(body_errors)\n if dependant.request_param_name:\n values[dependant.request_param_name] = request\n return values, errors\n\n\ndef get_app(dependant: Dependant):\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n\n async def app(request: Request) -> Response:\n values, errors = await solve_dependencies(request=request, dependant=dependant)\n if errors:\n errors_out = ValidationError(errors)\n raise HTTPException(\n status_code=HTTP_422_UNPROCESSABLE_ENTITY, detail=errors_out.errors()\n )\n else:\n if is_coroutine:\n raw_response = await dependant.call(**values)\n else:\n raw_response = await run_in_threadpool(dependant.call, **values)\n if isinstance(raw_response, Response):\n return raw_response\n else:\n return JSONResponse(content=jsonable_encoder(raw_response))\n return app\n\n\ndef get_openapi_params(dependant: Dependant):\n flat_dependant = get_flat_dependant(dependant)\n return (\n flat_dependant.path_params\n + flat_dependant.query_params\n + flat_dependant.header_params\n + flat_dependant.cookie_params\n )\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: typing.Callable,\n *,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n # TODO define how to read and provide security params, and how to have them globally too\n # TODO implement dependencies and injection\n # TODO refactor code structure\n # TODO create testing\n # TODO testing coverage\n assert path.startswith(\"/\"), \"Routed paths must always start '/'\"\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.include_in_schema = include_in_schema\n self.tags = tags\n self.summary = summary\n self.description = description\n self.operation_id = operation_id\n self.deprecated = deprecated\n self.request_body: typing.Union[BaseModel, Field, None] = None\n self.response_description = response_description\n self.response_code = response_code\n self.response_wrapper = response_wrapper\n self.response_field = None\n if response_type:\n assert lenient_issubclass(\n response_wrapper, JSONResponse\n ), \"To declare a type the response must be a JSON response\"\n self.response_type = response_type\n response_name = \"Response_\" + self.name\n self.response_field = Field(\n name=response_name,\n type_=self.response_type,\n class_validators=[],\n default=None,\n required=False,\n model_config=BaseConfig(),\n schema=Schema(None),\n )\n else:\n self.response_type = None\n if methods is None:\n methods = [\"GET\"]\n self.methods = methods\n self.path_regex, self.path_format, self.param_convertors = self.compile_path(\n path\n )\n assert inspect.isfunction(endpoint) or inspect.ismethod(\n endpoint\n ), f\"An endpoint must be a function or method\"\n\n self.dependant = get_dependant(path=path, call=self.endpoint)\n # flat_dependant = get_flat_dependant(self.dependant)\n # path_param_names = get_path_param_names(path)\n # for path_param in path_param_names:\n # assert path_param in {\n # f.alias for f in flat_dependant.path_params\n # }, f\"Path parameter must be defined as a function parameter or be defined by a dependency: {path_param}\"\n\n if self.dependant.body_params:\n first_param = self.dependant.body_params[0]\n sub_key = getattr(first_param.schema, \"sub_key\", None)\n if len(self.dependant.body_params) == 1 and not sub_key:\n self.request_body = first_param\n else:\n model_name = \"Body_\" + self.name\n BodyModel = create_model(model_name)\n for f in self.dependant.body_params:\n BodyModel.__fields__[f.name] = f\n required = any(\n True for f in self.dependant.body_params if f.required)\n field = Field(\n name=\"body\",\n type_=BodyModel,\n default=None,\n required=required,\n model_config=BaseConfig,\n class_validators=[],\n alias=\"body\",\n schema=Schema(None),\n )\n self.request_body = field\n\n self.app = request_response(get_app(dependant=self.dependant))\n\n\nclass APIRouter(routing.Router):\n def add_api_route(\n self,\n path: str,\n endpoint: typing.Callable,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> None:\n route = APIRoute(\n path,\n endpoint=endpoint,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n methods: typing.List[str] = None,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ) -> typing.Callable:\n def decorator(func: typing.Callable) -> typing.Callable:\n self.add_api_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n return func\n\n return decorator\n\n def get(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"GET\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def put(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PUT\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def post(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"POST\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def delete(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"DELETE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def options(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"OPTIONS\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def head(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"HEAD\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def patch(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"PATCH\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n\n def trace(\n self,\n path: str,\n name: str = None,\n include_in_schema: bool = True,\n tags: typing.List[str] = [],\n summary: str = None,\n description: str = None,\n operation_id: str = None,\n deprecated: bool = None,\n response_type: typing.Type = None,\n response_description: str = \"Successful Response\",\n response_code=200,\n response_wrapper=JSONResponse,\n ):\n return self.api_route(\n path=path,\n methods=[\"TRACE\"],\n name=name,\n include_in_schema=include_in_schema,\n tags=tags,\n summary=summary,\n description=description,\n operation_id=operation_id,\n deprecated=deprecated,\n response_type=response_type,\n response_description=response_description,\n response_code=response_code,\n response_wrapper=response_wrapper,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events /) .\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https: // fastapi.tiangolo.com/advanced/events/ # alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":80,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing__on_event__9293795e99afbda07d2744f1eb7d23d2f0ea0154"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"9293795e99afbda07d2744f1eb7d23d2f0ea0154"},"fm_type":{"kind":"string","value":"method"},"fm_name":{"kind":"string","value":"on_event"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def on_event(\n self, event_type: str\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"gold_code":{"kind":"string","value":"def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n List,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.types import DecoratedCallable\nfrom fastapi.utils import (\n create_cloned_field,\n create_response_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import ModelField, Undefined\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import BaseRoute, Match\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp, Scope\nfrom starlette.websockets import WebSocket\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n res.__config__, \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return res.dict(\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[Union[SetIntStr, DictIntStrAny]] = None,\n exclude: Optional[Union[SetIntStr, DictIntStrAny]] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors, field.type_)\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr, DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n stack = request.scope.get(\"fastapi_astack\")\n assert isinstance(stack, AsyncExitStack)\n stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n raise RequestValidationError(\n [ErrorWrapper(e, (\"body\", e.pos))], body=e.doc\n ) from e\n except HTTPException:\n raise\n except Exception as e:\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors, body=body)\n else:\n raw_response = await run_endpoint_function(\n dependant=dependant, values=values, is_coroutine=is_coroutine\n )\n\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_args: Dict[str, Any] = {\"background\": background_tasks}\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code if status_code else sub_response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if sub_response.status_code:\n response_args[\"status_code\"] = sub_response.status_code\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(sub_response.headers.raw)\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Optional[Any] = None\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[\n [\"APIRoute\"], str\n ] = generate_unique_id_function.value\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_response_field(\n name=response_name, type_=self.response_model\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[\n ModelField\n ] = create_cloned_field(self.response_field)\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_response_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n *,\n prefix: str = \"\",\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n default_response_class: Type[Response] = Default(JSONResponse),\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n routes: Optional[List[routing.BaseRoute]] = None,\n redirect_slashes: bool = True,\n default: Optional[ASGIApp] = None,\n dependency_overrides_provider: Optional[Any] = None,\n route_class: Type[APIRoute] = APIRoute,\n on_startup: Optional[Sequence[Callable[[], Any]]] = None,\n on_shutdown: Optional[Sequence[Callable[[], Any]]] = None,\n deprecated: Optional[bool] = None,\n include_in_schema: bool = True,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or []) or []\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable[..., Any], name: Optional[str] = None\n ) -> None:\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self, path: str, name: Optional[str] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n default_response_class: Type[Response] = Default(JSONResponse),\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n deprecated: Optional[bool] = None,\n include_in_schema: bool = True,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n\n def get(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def on_event(\n self, event_type: str\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n Callable,\n Coroutine,\n Dict,\n List,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.types import DecoratedCallable\nfrom fastapi.utils import (\n create_cloned_field,\n create_response_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom pydantic.fields import ModelField, Undefined\nfrom pydantic.utils import lenient_issubclass\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import BaseRoute, Match\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp, Scope\nfrom starlette.websockets import WebSocket\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n res.__config__, \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return res.dict(\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[Union[SetIntStr, DictIntStrAny]] = None,\n exclude: Optional[Union[SetIntStr, DictIntStrAny]] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors, field.type_)\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[Union[SetIntStr, DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr, DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n stack = request.scope.get(\"fastapi_astack\")\n assert isinstance(stack, AsyncExitStack)\n stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n raise RequestValidationError(\n [ErrorWrapper(e, (\"body\", e.pos))], body=e.doc\n ) from e\n except HTTPException:\n raise\n except Exception as e:\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors, body=body)\n else:\n raw_response = await run_endpoint_function(\n dependant=dependant, values=values, is_coroutine=is_coroutine\n )\n\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_args: Dict[str, Any] = {\"background\": background_tasks}\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code if status_code else sub_response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if sub_response.status_code:\n response_args[\"status_code\"] = sub_response.status_code\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(sub_response.headers.raw)\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Optional[Any] = None\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[\n [\"APIRoute\"], str\n ] = generate_unique_id_function.value\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_response_field(\n name=response_name, type_=self.response_model\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[\n ModelField\n ] = create_cloned_field(self.response_field)\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_response_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n *,\n prefix: str = \"\",\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n default_response_class: Type[Response] = Default(JSONResponse),\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n routes: Optional[List[routing.BaseRoute]] = None,\n redirect_slashes: bool = True,\n default: Optional[ASGIApp] = None,\n dependency_overrides_provider: Optional[Any] = None,\n route_class: Type[APIRoute] = APIRoute,\n on_startup: Optional[Sequence[Callable[[], Any]]] = None,\n on_shutdown: Optional[Sequence[Callable[[], Any]]] = None,\n deprecated: Optional[bool] = None,\n include_in_schema: bool = True,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or []) or []\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable[..., Any], name: Optional[str] = None\n ) -> None:\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self, path: str, name: Optional[str] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n default_response_class: Type[Response] = Default(JSONResponse),\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n deprecated: Optional[bool] = None,\n include_in_schema: bool = True,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n\n def get(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_exclude: Optional[Union[SetIntStr,\n DictIntStrAny]] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def on_event(\n self, event_type: str\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n______________ ERROR collecting tests/test_custom_route_class.py _______________\nImportError while importing test module '/workspace/test_repo/tests/test_custom_route_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_custom_route_class.py:2: in <module>\n from fastapi import APIRouter, FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nE ImportError: cannot import name '_should_embed_body_fields' from 'fastapi.dependencies.utils' (/workspace/test_repo/fastapi/dependencies/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_custom_route_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.58s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 5, 'passed': 5, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/routing.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_custom_route_class.py"}}},{"rowIdx":81,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__is_body_allowed_for_status_code__c43120258fa89bc20d6f8ee671b6ead9ab223fc7"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"c43120258fa89bc20d6f8ee671b6ead9ab223fc7"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"is_body_allowed_for_status_code"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 304})\n"},"gold_code":{"kind":"string","value":"def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 304})\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo()\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_inherited_custom_class.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_inherited_custom_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_inherited_custom_class.py:4: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_inherited_custom_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_inherited_custom_class.py"}}},{"rowIdx":82,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__get_path_param_names__b9d912c6380661647b51c322820fcb4ba08f32d2"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b9d912c6380661647b51c322820fcb4ba08f32d2"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_path_param_names"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n"},"gold_code":{"kind":"string","value":"def get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Dict, Sequence, Set, Type\n\nfrom starlette.routing import BaseRoute\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseModel\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]):\n body_fields_from_routes = []\n responses_from_routes = []\n for route in routes:\n if route.include_in_schema and isinstance(route, routing.APIRoute):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n):\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Dict, Sequence, Set, Type\n\nfrom starlette.routing import BaseRoute\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseModel\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]):\n body_fields_from_routes = []\n responses_from_routes = []\n for route in routes:\n if route.include_in_schema and isinstance(route, routing.APIRoute):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n):\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_inherited_custom_class.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_inherited_custom_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_inherited_custom_class.py:4: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_inherited_custom_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.63s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_inherited_custom_class.py"}}},{"rowIdx":83,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__create_cloned_field__aa84ac8e3e305d76e71c0c1b31237517948fa12f"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"aa84ac8e3e305d76e71c0c1b31237517948fa12f"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"create_cloned_field"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"gold_code":{"kind":"string","value":"def create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(\n routes: Sequence[Type[BaseRoute]]\n) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n default = None,\n required = False,\n model_config = BaseConfig,\n schema = Schema(None),\n )\n new_field.has_alias= field.has_alias\n new_field.alias= field.alias\n new_field.class_validators= field.class_validators\n new_field.default= field.default\n new_field.required= field.required\n new_field.model_config= field.model_config\n new_field.schema= field.schema\n new_field.allow_none= field.allow_none\n new_field.validate_always= field.validate_always\n if field.sub_fields:\n new_field.sub_fields= [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(\n routes: Sequence[Type[BaseRoute]]\n) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_inherited_custom_class.py _____________\ntests/test_inherited_custom_class.py:4: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nfastapi/utils.py:109: in <module>\n def create_cloned_field(field: Field) -> Field:\nE NameError: name 'Field' is not defined\n=========================== short test summary info ============================\nERROR tests/test_inherited_custom_class.py - NameError: name 'Field' is not d...\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.61s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_inherited_custom_class.py"}}},{"rowIdx":84,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__generate_operation_id_for_path__687065509b047a642acd1d281d6d68c6698509b1"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"687065509b047a642acd1d281d6d68c6698509b1"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"generate_operation_id_for_path"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"gold_code":{"kind":"string","value":"def generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_inherited_custom_class.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_inherited_custom_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_inherited_custom_class.py:4: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_inherited_custom_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.61s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_inherited_custom_class.py"}}},{"rowIdx":85,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__generate_unique_id__8a0d4c79c18e6bd219b965b9d50578c139e7efd8"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"8a0d4c79c18e6bd219b965b9d50578c139e7efd8"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"generate_unique_id"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n"},"gold_code":{"kind":"string","value":"def generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_inherited_custom_class.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_inherited_custom_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_inherited_custom_class.py:4: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_inherited_custom_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.59s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_inherited_custom_class.py"}}},{"rowIdx":86,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__deep_dict_update__181a32236a32305788b87d10e7990d9564ae2056"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"181a32236a32305788b87d10e7990d9564ae2056"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"deep_dict_update"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def deep_dict_update(main_dict: dict, update_dict: dict) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n"},"gold_code":{"kind":"string","value":"def deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\ntry:\n from pydantic.fields import FieldInfo, ModelField, UndefinedType\n\n PYDANTIC_1 = True\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n\n class UndefinedType: # type: ignore\n def __repr__(self) -> str:\n return \"PydanticUndefined\"\n\n logger.warning(\n \"Pydantic versions < 1.0.0 are deprecated in FastAPI and support will be \"\n \"removed soon.\"\n )\n PYDANTIC_1 = False\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef get_field_info(field: ModelField) -> FieldInfo:\n if PYDANTIC_1:\n return field.field_info # type: ignore\n else:\n return field.schema # type: ignore # pragma: nocover\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef warning_response_model_skip_defaults_deprecated() -> None:\n logger.warning( # pragma: nocover\n \"response_model_skip_defaults has been deprecated in favor of \"\n \"response_model_exclude_unset to keep in line with Pydantic v1, support for \"\n \"it will be removed soon.\"\n )\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n # ignore mypy error until enum schemas are released\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n if PYDANTIC_1:\n return response_field(field_info=field_info)\n else: # pragma: nocover\n return response_field(schema=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__ # type: ignore\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n if PYDANTIC_1:\n new_field.field_info = field.field_info\n else: # pragma: nocover\n new_field.schema = field.schema # type: ignore\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n if PYDANTIC_1:\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n else: # pragma: nocover\n new_field.whole_pre_validators = field.whole_pre_validators # type: ignore\n new_field.whole_post_validators = field.whole_post_validators # type: ignore\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n try:\n new_field.populate_validators()\n except AttributeError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n new_field._populate_validators() # type: ignore\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\ntry:\n from pydantic.fields import FieldInfo, ModelField, UndefinedType\n\n PYDANTIC_1 = True\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n\n class UndefinedType: # type: ignore\n def __repr__(self) -> str:\n return \"PydanticUndefined\"\n\n logger.warning(\n \"Pydantic versions < 1.0.0 are deprecated in FastAPI and support will be \"\n \"removed soon.\"\n )\n PYDANTIC_1 = False\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef get_field_info(field: ModelField) -> FieldInfo:\n if PYDANTIC_1:\n return field.field_info # type: ignore\n else:\n return field.schema # type: ignore # pragma: nocover\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef warning_response_model_skip_defaults_deprecated() -> None:\n logger.warning( # pragma: nocover\n \"response_model_skip_defaults has been deprecated in favor of \"\n \"response_model_exclude_unset to keep in line with Pydantic v1, support for \"\n \"it will be removed soon.\"\n )\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n # ignore mypy error until enum schemas are released\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n if PYDANTIC_1:\n return response_field(field_info=field_info)\n else: # pragma: nocover\n return response_field(schema=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__ # type: ignore\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n if PYDANTIC_1:\n new_field.field_info = field.field_info\n else: # pragma: nocover\n new_field.schema = field.schema # type: ignore\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n if PYDANTIC_1:\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n else: # pragma: nocover\n new_field.whole_pre_validators = field.whole_pre_validators # type: ignore\n new_field.whole_post_validators = field.whole_post_validators # type: ignore\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n try:\n new_field.populate_validators()\n except AttributeError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n new_field._populate_validators() # type: ignore\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: dict, update_dict: dict) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n____________ ERROR collecting tests/test_inherited_custom_class.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_inherited_custom_class.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_inherited_custom_class.py:4: in <module>\n from fastapi import FastAPI\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_inherited_custom_class.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.61s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 2, 'passed': 1, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 1, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_inherited_custom_class.py"}}},{"rowIdx":87,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__is_body_allowed_for_status_code__c43120258fa89bc20d6f8ee671b6ead9ab223fc7"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"c43120258fa89bc20d6f8ee671b6ead9ab223fc7"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"is_body_allowed_for_status_code"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 304})\n"},"gold_code":{"kind":"string","value":"def is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 304})\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo()\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n_____________ ERROR collecting tests/test_regex_deprecated_body.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_regex_deprecated_body.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_regex_deprecated_body.py:3: in <module>\n from fastapi import FastAPI, Form\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_regex_deprecated_body.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.61s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 4, 'passed': 4, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_regex_deprecated_body.py"}}},{"rowIdx":88,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__get_path_param_names__b9d912c6380661647b51c322820fcb4ba08f32d2"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"b9d912c6380661647b51c322820fcb4ba08f32d2"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_path_param_names"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n"},"gold_code":{"kind":"string","value":"def get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Dict, Sequence, Set, Type\n\nfrom starlette.routing import BaseRoute\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseModel\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]):\n body_fields_from_routes = []\n responses_from_routes = []\n for route in routes:\n if route.include_in_schema and isinstance(route, routing.APIRoute):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n):\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Dict, Sequence, Set, Type\n\nfrom starlette.routing import BaseRoute\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseModel\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]):\n body_fields_from_routes = []\n responses_from_routes = []\n for route in routes:\n if route.include_in_schema and isinstance(route, routing.APIRoute):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n):\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str):\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n_____________ ERROR collecting tests/test_regex_deprecated_body.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_regex_deprecated_body.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_regex_deprecated_body.py:3: in <module>\n from fastapi import FastAPI, Form\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_regex_deprecated_body.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.61s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 4, 'passed': 4, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_regex_deprecated_body.py"}}},{"rowIdx":89,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__create_cloned_field__aa84ac8e3e305d76e71c0c1b31237517948fa12f"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"aa84ac8e3e305d76e71c0c1b31237517948fa12f"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"create_cloned_field"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"gold_code":{"kind":"string","value":"def create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(\n routes: Sequence[Type[BaseRoute]]\n) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n default = None,\n required = False,\n model_config = BaseConfig,\n schema = Schema(None),\n )\n new_field.has_alias= field.has_alias\n new_field.alias= field.alias\n new_field.class_validators= field.class_validators\n new_field.default= field.default\n new_field.required= field.required\n new_field.model_config= field.model_config\n new_field.schema= field.schema\n new_field.allow_none= field.allow_none\n new_field.validate_always= field.validate_always\n if field.sub_fields:\n new_field.sub_fields= [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(\n routes: Sequence[Type[BaseRoute]]\n) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n_____________ ERROR collecting tests/test_regex_deprecated_body.py _____________\ntests/test_regex_deprecated_body.py:3: in <module>\n from fastapi import FastAPI, Form\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nfastapi/utils.py:109: in <module>\n def create_cloned_field(field: Field) -> Field:\nE NameError: name 'Field' is not defined\n=========================== short test summary info ============================\nERROR tests/test_regex_deprecated_body.py - NameError: name 'Field' is not de...\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 4, 'passed': 4, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_regex_deprecated_body.py"}}},{"rowIdx":90,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__generate_operation_id_for_path__687065509b047a642acd1d281d6d68c6698509b1"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"687065509b047a642acd1d281d6d68c6698509b1"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"generate_operation_id_for_path"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"gold_code":{"kind":"string","value":"def generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n"},"old_filtered_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"old_complete_context":{"kind":"string","value":"import re\nfrom typing import Any, Dict, List, Sequence, Set, Type, cast\n\nfrom fastapi import routing\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, Schema, create_model\nfrom pydantic.fields import Field\nfrom pydantic.schema import get_flat_models_from_fields, model_process_schema\nfrom pydantic.utils import lenient_issubclass\nfrom starlette.routing import BaseRoute\n\n\ndef get_flat_models_from_routes(routes: Sequence[BaseRoute]) -> Set[Type[BaseModel]]:\n body_fields_from_routes: List[Field] = []\n responses_from_routes: List[Field] = []\n for route in routes:\n if getattr(route, \"include_in_schema\", None) and isinstance(\n route, routing.APIRoute\n ):\n if route.body_field:\n assert isinstance(\n route.body_field, Field\n ), \"A request body must be a Pydantic Field\"\n body_fields_from_routes.append(route.body_field)\n if route.response_field:\n responses_from_routes.append(route.response_field)\n if route.response_fields:\n responses_from_routes.extend(route.response_fields.values())\n flat_models = get_flat_models_from_fields(\n body_fields_from_routes + responses_from_routes, known_models=set()\n )\n return flat_models\n\n\ndef get_model_definitions(\n *, flat_models: Set[Type[BaseModel]], model_name_map: Dict[Type[BaseModel], str]\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n m_schema, m_definitions = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return {item.strip(\"{}\") for item in re.findall(\"{[^}]*}\", path)}\n\n\ndef create_cloned_field(field: Field) -> Field:\n original_type = field.type_\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = create_model( # type: ignore\n original_type.__name__,\n __config__=original_type.__config__,\n __validators__=original_type.__validators__,\n )\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = f\n new_field = Field(\n name=field.name,\n type_=use_type,\n class_validators={},\n default=None,\n required=False,\n model_config=BaseConfig,\n schema=Schema(None),\n )\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.schema = field.schema\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field) for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(field.key_field)\n new_field.validators = field.validators\n new_field.whole_pre_validators = field.whole_pre_validators\n new_field.whole_post_validators = field.whole_post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field._populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = operation_id.replace(\n \"{\", \"_\").replace(\"}\", \"_\").replace(\"/\", \"_\")\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n_____________ ERROR collecting tests/test_regex_deprecated_body.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_regex_deprecated_body.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_regex_deprecated_body.py:3: in <module>\n from fastapi import FastAPI, Form\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_regex_deprecated_body.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.61s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 4, 'passed': 4, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_regex_deprecated_body.py"}}},{"rowIdx":91,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__generate_unique_id__8a0d4c79c18e6bd219b965b9d50578c139e7efd8"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"8a0d4c79c18e6bd219b965b9d50578c139e7efd8"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"generate_unique_id"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n"},"gold_code":{"kind":"string","value":"def generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import TYPE_CHECKING, Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.fields import FieldInfo, ModelField, UndefinedType\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n return response_field(field_info=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[Dict[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n new_field.populate_validators()\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = route.name + route.path_format\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n assert route.methods\n operation_id = operation_id + \"_\" + list(route.methods)[0].lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n_____________ ERROR collecting tests/test_regex_deprecated_body.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_regex_deprecated_body.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_regex_deprecated_body.py:3: in <module>\n from fastapi import FastAPI, Form\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_regex_deprecated_body.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 4, 'passed': 4, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_regex_deprecated_body.py"}}},{"rowIdx":92,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__utils__deep_dict_update__181a32236a32305788b87d10e7990d9564ae2056"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"181a32236a32305788b87d10e7990d9564ae2056"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"deep_dict_update"},"pyfile_name":{"kind":"string","value":"utils.py"},"original_code":{"kind":"string","value":"def deep_dict_update(main_dict: dict, update_dict: dict) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n"},"gold_code":{"kind":"string","value":"def deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n"},"old_filtered_context":{"kind":"string","value":"import functools\nimport re\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\ntry:\n from pydantic.fields import FieldInfo, ModelField, UndefinedType\n\n PYDANTIC_1 = True\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n\n class UndefinedType: # type: ignore\n def __repr__(self) -> str:\n return \"PydanticUndefined\"\n\n logger.warning(\n \"Pydantic versions < 1.0.0 are deprecated in FastAPI and support will be \"\n \"removed soon.\"\n )\n PYDANTIC_1 = False\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef get_field_info(field: ModelField) -> FieldInfo:\n if PYDANTIC_1:\n return field.field_info # type: ignore\n else:\n return field.schema # type: ignore # pragma: nocover\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef warning_response_model_skip_defaults_deprecated() -> None:\n logger.warning( # pragma: nocover\n \"response_model_skip_defaults has been deprecated in favor of \"\n \"response_model_exclude_unset to keep in line with Pydantic v1, support for \"\n \"it will be removed soon.\"\n )\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n # ignore mypy error until enum schemas are released\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n if PYDANTIC_1:\n return response_field(field_info=field_info)\n else: # pragma: nocover\n return response_field(schema=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__ # type: ignore\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n if PYDANTIC_1:\n new_field.field_info = field.field_info\n else: # pragma: nocover\n new_field.schema = field.schema # type: ignore\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n if PYDANTIC_1:\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n else: # pragma: nocover\n new_field.whole_pre_validators = field.whole_pre_validators # type: ignore\n new_field.whole_post_validators = field.whole_post_validators # type: ignore\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n try:\n new_field.populate_validators()\n except AttributeError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n new_field._populate_validators() # type: ignore\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n"},"old_complete_context":{"kind":"string","value":"import functools\nimport re\nfrom dataclasses import is_dataclass\nfrom enum import Enum\nfrom typing import Any, Dict, Optional, Set, Type, Union, cast\n\nimport fastapi\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import REF_PREFIX\nfrom pydantic import BaseConfig, BaseModel, create_model\nfrom pydantic.class_validators import Validator\nfrom pydantic.schema import model_process_schema\nfrom pydantic.utils import lenient_issubclass\n\ntry:\n from pydantic.fields import FieldInfo, ModelField, UndefinedType\n\n PYDANTIC_1 = True\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic.fields import Field as ModelField # type: ignore\n from pydantic import Schema as FieldInfo # type: ignore\n\n class UndefinedType: # type: ignore\n def __repr__(self) -> str:\n return \"PydanticUndefined\"\n\n logger.warning(\n \"Pydantic versions < 1.0.0 are deprecated in FastAPI and support will be \"\n \"removed soon.\"\n )\n PYDANTIC_1 = False\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef get_field_info(field: ModelField) -> FieldInfo:\n if PYDANTIC_1:\n return field.field_info # type: ignore\n else:\n return field.schema # type: ignore # pragma: nocover\n\n\n# TODO: remove when removing support for Pydantic < 1.0.0\ndef warning_response_model_skip_defaults_deprecated() -> None:\n logger.warning( # pragma: nocover\n \"response_model_skip_defaults has been deprecated in favor of \"\n \"response_model_exclude_unset to keep in line with Pydantic v1, support for \"\n \"it will be removed soon.\"\n )\n\n\ndef get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n) -> Dict[str, Any]:\n definitions: Dict[str, Dict] = {}\n for model in flat_models:\n # ignore mypy error until enum schemas are released\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX # type: ignore\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n definitions[model_name] = m_schema\n return definitions\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_response_field(\n name: str,\n type_: Type[Any],\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = None,\n required: Union[bool, UndefinedType] = False,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n) -> ModelField:\n \"\"\"\n Create a new response field. Raises if type_ is invalid.\n \"\"\"\n class_validators = class_validators or {}\n field_info = field_info or FieldInfo(None)\n\n response_field = functools.partial(\n ModelField,\n name=name,\n type_=type_,\n class_validators=class_validators,\n default=default,\n required=required,\n model_config=model_config,\n alias=alias,\n )\n\n try:\n if PYDANTIC_1:\n return response_field(field_info=field_info)\n else: # pragma: nocover\n return response_field(schema=field_info)\n except RuntimeError:\n raise fastapi.exceptions.FastAPIError(\n f\"Invalid args for response field! Hint: check that {type_} is a valid pydantic field type\"\n )\n\n\ndef create_cloned_field(\n field: ModelField, *, cloned_types: Dict[Type[BaseModel], Type[BaseModel]] = None,\n) -> ModelField:\n # _cloned_types has already cloned types, to support recursive models\n if cloned_types is None:\n cloned_types = dict()\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__ # type: ignore\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_response_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias\n new_field.alias = field.alias\n new_field.class_validators = field.class_validators\n new_field.default = field.default\n new_field.required = field.required\n new_field.model_config = field.model_config\n if PYDANTIC_1:\n new_field.field_info = field.field_info\n else: # pragma: nocover\n new_field.schema = field.schema # type: ignore\n new_field.allow_none = field.allow_none\n new_field.validate_always = field.validate_always\n if field.sub_fields:\n new_field.sub_fields = [\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields\n ]\n if field.key_field:\n new_field.key_field = create_cloned_field(\n field.key_field, cloned_types=cloned_types\n )\n new_field.validators = field.validators\n if PYDANTIC_1:\n new_field.pre_validators = field.pre_validators\n new_field.post_validators = field.post_validators\n else: # pragma: nocover\n new_field.whole_pre_validators = field.whole_pre_validators # type: ignore\n new_field.whole_post_validators = field.whole_post_validators # type: ignore\n new_field.parse_json = field.parse_json\n new_field.shape = field.shape\n try:\n new_field.populate_validators()\n except AttributeError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n new_field._populate_validators() # type: ignore\n return new_field\n\n\ndef generate_operation_id_for_path(*, name: str, path: str, method: str) -> str:\n operation_id = name + path\n operation_id = re.sub(\"[^0-9a-zA-Z_]\", \"_\", operation_id)\n operation_id = operation_id + \"_\" + method.lower()\n return operation_id\n\n\ndef deep_dict_update(main_dict: dict, update_dict: dict) -> None:\n for key in update_dict:\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(update_dict[key], dict)\n ):\n deep_dict_update(main_dict[key], update_dict[key])\n else:\n main_dict[key] = update_dict[key]\n"},"new_filtered_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel],\n Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(\n original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n # type: ignore[attr-defined]\n new_field.class_validators = field.class_validators\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators\n # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"new_complete_context":{"kind":"string","value":"import re\nimport warnings\nfrom dataclasses import is_dataclass\nfrom typing import (\n TYPE_CHECKING,\n Any,\n Dict,\n MutableMapping,\n Optional,\n Set,\n Type,\n Union,\n cast,\n)\nfrom weakref import WeakKeyDictionary\n\nimport fastapi\nfrom fastapi._compat import (\n PYDANTIC_V2,\n BaseConfig,\n ModelField,\n PydanticSchemaGenerationError,\n Undefined,\n UndefinedType,\n Validator,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import DefaultPlaceholder, DefaultType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.fields import FieldInfo\nfrom typing_extensions import Literal\n\nif TYPE_CHECKING: # pragma: nocover\n from .routing import APIRoute\n\n# Cache for `create_cloned_field`\n_CLONED_TYPES_CACHE: MutableMapping[Type[BaseModel], Type[BaseModel]] = (\n WeakKeyDictionary()\n)\n\n\ndef is_body_allowed_for_status_code(status_code: Union[int, str, None]) -> bool:\n if status_code is None:\n return True\n # Ref: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#patterned-fields-1\n if status_code in {\n \"default\",\n \"1XX\",\n \"2XX\",\n \"3XX\",\n \"4XX\",\n \"5XX\",\n }:\n return True\n current_status_code = int(status_code)\n return not (current_status_code < 200 or current_status_code in {204, 205, 304})\n\n\ndef get_path_param_names(path: str) -> Set[str]:\n return set(re.findall(\"{(.*?)}\", path))\n\n\ndef create_model_field(\n name: str,\n type_: Any,\n class_validators: Optional[Dict[str, Validator]] = None,\n default: Optional[Any] = Undefined,\n required: Union[bool, UndefinedType] = Undefined,\n model_config: Type[BaseConfig] = BaseConfig,\n field_info: Optional[FieldInfo] = None,\n alias: Optional[str] = None,\n mode: Literal[\"validation\", \"serialization\"] = \"validation\",\n) -> ModelField:\n class_validators = class_validators or {}\n if PYDANTIC_V2:\n field_info = field_info or FieldInfo(\n annotation=type_, default=default, alias=alias\n )\n else:\n field_info = field_info or FieldInfo()\n kwargs = {\"name\": name, \"field_info\": field_info}\n if PYDANTIC_V2:\n kwargs.update({\"mode\": mode})\n else:\n kwargs.update(\n {\n \"type_\": type_,\n \"class_validators\": class_validators,\n \"default\": default,\n \"required\": required,\n \"model_config\": model_config,\n \"alias\": alias,\n }\n )\n try:\n return ModelField(**kwargs) # type: ignore[arg-type]\n except (RuntimeError, PydanticSchemaGenerationError):\n raise fastapi.exceptions.FastAPIError(\n \"Invalid args for response field! Hint: \"\n f\"check that {type_} is a valid Pydantic field type. \"\n \"If you are using a return type annotation that is not a valid Pydantic \"\n \"field (e.g. Union[Response, dict, None]) you can disable generating the \"\n \"response model from the type annotation with the path operation decorator \"\n \"parameter response_model=None. Read more: \"\n \"https://fastapi.tiangolo.com/tutorial/response-model/\"\n ) from None\n\n\ndef create_cloned_field(\n field: ModelField,\n *,\n cloned_types: Optional[MutableMapping[Type[BaseModel], Type[BaseModel]]] = None,\n) -> ModelField:\n if PYDANTIC_V2:\n return field\n # cloned_types caches already cloned types to support recursive models and improve\n # performance by avoiding unnecessary cloning\n if cloned_types is None:\n cloned_types = _CLONED_TYPES_CACHE\n\n original_type = field.type_\n if is_dataclass(original_type) and hasattr(original_type, \"__pydantic_model__\"):\n original_type = original_type.__pydantic_model__\n use_type = original_type\n if lenient_issubclass(original_type, BaseModel):\n original_type = cast(Type[BaseModel], original_type)\n use_type = cloned_types.get(original_type)\n if use_type is None:\n use_type = create_model(original_type.__name__, __base__=original_type)\n cloned_types[original_type] = use_type\n for f in original_type.__fields__.values():\n use_type.__fields__[f.name] = create_cloned_field(\n f, cloned_types=cloned_types\n )\n new_field = create_model_field(name=field.name, type_=use_type)\n new_field.has_alias = field.has_alias # type: ignore[attr-defined]\n new_field.alias = field.alias # type: ignore[misc]\n new_field.class_validators = field.class_validators # type: ignore[attr-defined]\n new_field.default = field.default # type: ignore[misc]\n new_field.required = field.required # type: ignore[misc]\n new_field.model_config = field.model_config # type: ignore[attr-defined]\n new_field.field_info = field.field_info\n new_field.allow_none = field.allow_none # type: ignore[attr-defined]\n new_field.validate_always = field.validate_always # type: ignore[attr-defined]\n if field.sub_fields: # type: ignore[attr-defined]\n new_field.sub_fields = [ # type: ignore[attr-defined]\n create_cloned_field(sub_field, cloned_types=cloned_types)\n for sub_field in field.sub_fields # type: ignore[attr-defined]\n ]\n if field.key_field: # type: ignore[attr-defined]\n new_field.key_field = create_cloned_field( # type: ignore[attr-defined]\n field.key_field, # type: ignore[attr-defined]\n cloned_types=cloned_types,\n )\n new_field.validators = field.validators # type: ignore[attr-defined]\n new_field.pre_validators = field.pre_validators # type: ignore[attr-defined]\n new_field.post_validators = field.post_validators # type: ignore[attr-defined]\n new_field.parse_json = field.parse_json # type: ignore[attr-defined]\n new_field.shape = field.shape # type: ignore[attr-defined]\n new_field.populate_validators() # type: ignore[attr-defined]\n return new_field\n\n\ndef generate_operation_id_for_path(\n *, name: str, path: str, method: str\n) -> str: # pragma: nocover\n warnings.warn(\n \"fastapi.utils.generate_operation_id_for_path() was deprecated, \"\n \"it is not used internally, and will be removed soon\",\n DeprecationWarning,\n stacklevel=2,\n )\n operation_id = f\"{name}{path}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n operation_id = f\"{operation_id}_{method.lower()}\"\n return operation_id\n\n\ndef generate_unique_id(route: \"APIRoute\") -> str:\n operation_id = f\"{route.name}{route.path_format}\"\n operation_id = re.sub(r\"\\W\", \"_\", operation_id)\n assert route.methods\n operation_id = f\"{operation_id}_{list(route.methods)[0].lower()}\"\n return operation_id\n\n\ndef deep_dict_update(main_dict: Dict[Any, Any], update_dict: Dict[Any, Any]) -> None:\n for key, value in update_dict.items():\n if (\n key in main_dict\n and isinstance(main_dict[key], dict)\n and isinstance(value, dict)\n ):\n deep_dict_update(main_dict[key], value)\n elif (\n key in main_dict\n and isinstance(main_dict[key], list)\n and isinstance(update_dict[key], list)\n ):\n main_dict[key] = main_dict[key] + update_dict[key]\n else:\n main_dict[key] = value\n\n\ndef get_value_or_default(\n first_item: Union[DefaultPlaceholder, DefaultType],\n *extra_items: Union[DefaultPlaceholder, DefaultType],\n) -> Union[DefaultPlaceholder, DefaultType]:\n \"\"\"\n Pass items or `DefaultPlaceholder`s by descending priority.\n\n The first one to _not_ be a `DefaultPlaceholder` will be returned.\n\n Otherwise, the first item (a `DefaultPlaceholder`) will be returned.\n \"\"\"\n items = (first_item,) + extra_items\n for item in items:\n if not isinstance(item, DefaultPlaceholder):\n return item\n return first_item\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 0 items / 1 error\n\n==================================== ERRORS ====================================\n_____________ ERROR collecting tests/test_regex_deprecated_body.py _____________\nImportError while importing test module '/workspace/test_repo/tests/test_regex_deprecated_body.py'.\nHint: make sure your test modules/packages have valid Python names.\nTraceback:\n/usr/local/lib/python3.11/importlib/__init__.py:126: in import_module\n return _bootstrap._gcd_import(name[level:], package, level)\ntests/test_regex_deprecated_body.py:3: in <module>\n from fastapi import FastAPI, Form\nfastapi/__init__.py:7: in <module>\n from .applications import FastAPI as FastAPI\nfastapi/applications.py:16: in <module>\n from fastapi import routing\nfastapi/routing.py:35: in <module>\n from fastapi.dependencies.utils import (\nfastapi/dependencies/utils.py:57: in <module>\n from fastapi.utils import create_response_field, get_path_param_names\nE ImportError: cannot import name 'create_response_field' from 'fastapi.utils' (/workspace/test_repo/fastapi/utils.py)\n=========================== short test summary info ============================\nERROR tests/test_regex_deprecated_body.py\n!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!\n=============================== 1 error in 0.60s ===============================\n"},"gold_summary":{"kind":"string","value":"{'total': 4, 'passed': 4, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 1, 'passed': 0, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 1}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/utils.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_regex_deprecated_body.py"}}},{"rowIdx":93,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee___compat__get_schema_from_model_field__0976185af96ab2ee39c949c0456be616b01f8669"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"0976185af96ab2ee39c949c0456be616b01f8669"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_schema_from_model_field"},"pyfile_name":{"kind":"string","value":"_compat.py"},"original_code":{"kind":"string","value":"def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\n \"title\"\n ] = field.field_info.title or field.alias.title().replace(\"_\", \" \")\n return json_schema\n"},"gold_code":{"kind":"string","value":"def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n) -> Dict[str, Any]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, override_mode or field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\"title\"] = (\n field.field_info.title or field.alias.title().replace(\"_\", \" \")\n )\n return json_schema\n"},"old_filtered_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as PYDANTIC_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import MultiHostUrl as MultiHostUrl\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n from pydantic_core.core_schema import (\n general_plain_validator_function as general_plain_validator_function,\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def general_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"old_complete_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as PYDANTIC_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import MultiHostUrl as MultiHostUrl\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n from pydantic_core.core_schema import (\n general_plain_validator_function as general_plain_validator_function,\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\n \"title\"\n ] = field.field_info.title or field.alias.title().replace(\"_\", \" \")\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n inputs = [\n (field, field.mode, field._type_adapter.core_schema) for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions # type: ignore[return-value]\n\n def is_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n return field_annotation_is_scalar(\n field.field_info.annotation\n ) and not isinstance(field.field_info, params.Body)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_sequence(field.field_info.annotation)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_scalar_sequence(field.field_info.annotation)\n\n def is_bytes_field(field: ModelField) -> bool:\n return is_bytes_or_nonable_bytes_annotation(field.type_)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return is_bytes_sequence_annotation(field.type_)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return type(field_info).from_annotation(annotation)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n origin_type = (\n get_origin(\n field.field_info.annotation) or field.field_info.annotation\n )\n # type: ignore[arg-type]\n assert issubclass(origin_type, sequence_types)\n # type: ignore[no-any-return]\n return sequence_annotation_to_type[origin_type](value)\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n error = ValidationError.from_exception_data(\n \"Field required\", [{\"type\": \"missing\", \"loc\": loc, \"input\": {}}]\n ).errors()[0]\n error[\"input\"] = None\n return error # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n field_params = {\n f.name: (f.field_info.annotation, f.field_info) for f in fields}\n BodyModel: Type[BaseModel] = create_model(\n model_name, **field_params) # type: ignore[call-overload]\n return BodyModel\n\nelse:\n from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX\n from pydantic import AnyUrl as Url # noqa: F401\n from pydantic import ( # type: ignore[assignment]\n BaseConfig as BaseConfig, # noqa: F401\n )\n from pydantic import ValidationError as ValidationError # noqa: F401\n from pydantic.class_validators import ( # type: ignore[no-redef]\n Validator as Validator, # noqa: F401\n )\n from pydantic.error_wrappers import ( # type: ignore[no-redef]\n ErrorWrapper as ErrorWrapper, # noqa: F401\n )\n from pydantic.errors import MissingError\n from pydantic.fields import ( # type: ignore[attr-defined]\n SHAPE_FROZENSET,\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n )\n from pydantic.fields import FieldInfo as FieldInfo\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n ModelField as ModelField, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Required as Required, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Undefined as Undefined,\n )\n from pydantic.fields import ( # type: ignore[no-redef, attr-defined]\n UndefinedType as UndefinedType, # noqa: F401\n )\n from pydantic.networks import ( # type: ignore[no-redef]\n MultiHostDsn as MultiHostUrl, # noqa: F401\n )\n from pydantic.schema import (\n field_schema,\n get_flat_models_from_fields,\n get_model_name_map,\n model_process_schema,\n )\n from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401\n get_annotation_from_field_info as get_annotation_from_field_info,\n )\n from pydantic.typing import ( # type: ignore[no-redef]\n evaluate_forwardref as evaluate_forwardref, # noqa: F401\n )\n from pydantic.utils import ( # type: ignore[no-redef]\n lenient_issubclass as lenient_issubclass, # noqa: F401\n )\n\n GetJsonSchemaHandler = Any # type: ignore[assignment,misc]\n JsonSchemaValue = Dict[str, Any] # type: ignore[misc]\n CoreSchema = Any # type: ignore[assignment,misc]\n\n sequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_FROZENSET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n }\n sequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n }\n\n @dataclass\n class GenerateJsonSchema: # type: ignore[no-redef]\n ref_template: str\n\n class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]\n pass\n\n def general_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n models = get_flat_models_from_fields(fields, known_models=set())\n return {}, get_model_definitions(\n flat_models=models, model_name_map=model_name_map\n )\n\n def is_scalar_field(field: ModelField) -> bool:\n return is_pv1_scalar_field(field)\n\n def is_sequence_field(field: ModelField) -> bool:\n # type: ignore[attr-defined]\n return field.shape in sequence_shapes or _annotation_is_sequence(field.type_)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return is_pv1_scalar_sequence_field(field)\n\n def is_bytes_field(field: ModelField) -> bool:\n return lenient_issubclass(field.type_, bytes)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n # type: ignore[attr-defined]\n return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return copy(field_info)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n # type: ignore[no-any-return,attr-defined]\n return sequence_shape_to_type[field.shape](value)\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n missing_field_error = ErrorWrapper(\n MissingError(), loc=loc) # type: ignore[call-arg]\n new_error = ValidationError([missing_field_error], RequestErrorModel)\n return new_error.errors()[0] # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n BodyModel = create_model(model_name)\n for f in fields:\n BodyModel.__fields__[f.name] = f # type: ignore[index]\n return BodyModel\n\n\ndef _regenerate_error_with_loc(\n *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]\n) -> List[Dict[str, Any]]:\n updated_loc_errors: List[Any] = [\n {**err, \"loc\": loc_prefix + err.get(\"loc\", ())}\n for err in _normalize_errors(errors)\n ]\n\n return updated_loc_errors\n\n\ndef _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n if lenient_issubclass(annotation, (str, bytes)):\n return False\n return lenient_issubclass(annotation, sequence_types)\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"new_filtered_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as P_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\n# Reassign variable to make it reexported for mypy\nPYDANTIC_VERSION = P_VERSION\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n\n try:\n from pydantic_core.core_schema import (\n with_info_plain_validator_function as with_info_plain_validator_function,\n )\n except ImportError: # pragma: no cover\n from pydantic_core.core_schema import (\n general_plain_validator_function as with_info_plain_validator_function, # noqa: F401\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(include_url=False), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def with_info_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if field_annotation_is_sequence(arg):\n return True\n return False\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"new_complete_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as P_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\n# Reassign variable to make it reexported for mypy\nPYDANTIC_VERSION = P_VERSION\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n\n try:\n from pydantic_core.core_schema import (\n with_info_plain_validator_function as with_info_plain_validator_function,\n )\n except ImportError: # pragma: no cover\n from pydantic_core.core_schema import (\n general_plain_validator_function as with_info_plain_validator_function, # noqa: F401\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(include_url=False), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, override_mode or field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\"title\"] = (\n field.field_info.title or field.alias.title().replace(\"_\", \" \")\n )\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n inputs = [\n (field, override_mode or field.mode, field._type_adapter.core_schema)\n for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions # type: ignore[return-value]\n\n def is_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n return field_annotation_is_scalar(\n field.field_info.annotation\n ) and not isinstance(field.field_info, params.Body)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_sequence(field.field_info.annotation)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_scalar_sequence(field.field_info.annotation)\n\n def is_bytes_field(field: ModelField) -> bool:\n return is_bytes_or_nonable_bytes_annotation(field.type_)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return is_bytes_sequence_annotation(field.type_)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n cls = type(field_info)\n merged_field_info = cls.from_annotation(annotation)\n new_field_info = copy(field_info)\n new_field_info.metadata = merged_field_info.metadata\n new_field_info.annotation = merged_field_info.annotation\n return new_field_info\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n origin_type = (\n get_origin(field.field_info.annotation) or field.field_info.annotation\n )\n assert issubclass(origin_type, sequence_types) # type: ignore[arg-type]\n return sequence_annotation_to_type[origin_type](value) # type: ignore[no-any-return]\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n error = ValidationError.from_exception_data(\n \"Field required\", [{\"type\": \"missing\", \"loc\": loc, \"input\": {}}]\n ).errors(include_url=False)[0]\n error[\"input\"] = None\n return error # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n field_params = {f.name: (f.field_info.annotation, f.field_info) for f in fields}\n BodyModel: Type[BaseModel] = create_model(model_name, **field_params) # type: ignore[call-overload]\n return BodyModel\n\n def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:\n return [\n ModelField(field_info=field_info, name=name)\n for name, field_info in model.model_fields.items()\n ]\n\nelse:\n from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX\n from pydantic import AnyUrl as Url # noqa: F401\n from pydantic import ( # type: ignore[assignment]\n BaseConfig as BaseConfig, # noqa: F401\n )\n from pydantic import ValidationError as ValidationError # noqa: F401\n from pydantic.class_validators import ( # type: ignore[no-redef]\n Validator as Validator, # noqa: F401\n )\n from pydantic.error_wrappers import ( # type: ignore[no-redef]\n ErrorWrapper as ErrorWrapper, # noqa: F401\n )\n from pydantic.errors import MissingError\n from pydantic.fields import ( # type: ignore[attr-defined]\n SHAPE_FROZENSET,\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n )\n from pydantic.fields import FieldInfo as FieldInfo\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n ModelField as ModelField, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Required as Required, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Undefined as Undefined,\n )\n from pydantic.fields import ( # type: ignore[no-redef, attr-defined]\n UndefinedType as UndefinedType, # noqa: F401\n )\n from pydantic.schema import (\n field_schema,\n get_flat_models_from_fields,\n get_model_name_map,\n model_process_schema,\n )\n from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401\n get_annotation_from_field_info as get_annotation_from_field_info,\n )\n from pydantic.typing import ( # type: ignore[no-redef]\n evaluate_forwardref as evaluate_forwardref, # noqa: F401\n )\n from pydantic.utils import ( # type: ignore[no-redef]\n lenient_issubclass as lenient_issubclass, # noqa: F401\n )\n\n GetJsonSchemaHandler = Any # type: ignore[assignment,misc]\n JsonSchemaValue = Dict[str, Any] # type: ignore[misc]\n CoreSchema = Any # type: ignore[assignment,misc]\n\n sequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_FROZENSET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n }\n sequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n }\n\n @dataclass\n class GenerateJsonSchema: # type: ignore[no-redef]\n ref_template: str\n\n class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]\n pass\n\n def with_info_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n for sub_field in field.sub_fields: # type: ignore[attr-defined]\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n models = get_flat_models_from_fields(fields, known_models=set())\n return {}, get_model_definitions(\n flat_models=models, model_name_map=model_name_map\n )\n\n def is_scalar_field(field: ModelField) -> bool:\n return is_pv1_scalar_field(field)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field.shape in sequence_shapes or _annotation_is_sequence(field.type_) # type: ignore[attr-defined]\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return is_pv1_scalar_sequence_field(field)\n\n def is_bytes_field(field: ModelField) -> bool:\n return lenient_issubclass(field.type_, bytes)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes) # type: ignore[attr-defined]\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return copy(field_info)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n return sequence_shape_to_type[field.shape](value) # type: ignore[no-any-return,attr-defined]\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n missing_field_error = ErrorWrapper(MissingError(), loc=loc) # type: ignore[call-arg]\n new_error = ValidationError([missing_field_error], RequestErrorModel)\n return new_error.errors()[0] # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n BodyModel = create_model(model_name)\n for f in fields:\n BodyModel.__fields__[f.name] = f # type: ignore[index]\n return BodyModel\n\n def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:\n return list(model.__fields__.values()) # type: ignore[attr-defined]\n\n\ndef _regenerate_error_with_loc(\n *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]\n) -> List[Dict[str, Any]]:\n updated_loc_errors: List[Any] = [\n {**err, \"loc\": loc_prefix + err.get(\"loc\", ())}\n for err in _normalize_errors(errors)\n ]\n\n return updated_loc_errors\n\n\ndef _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n if lenient_issubclass(annotation, (str, bytes)):\n return False\n return lenient_issubclass(annotation, sequence_types)\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if field_annotation_is_sequence(arg):\n return True\n return False\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes)) # type: ignore[arg-type]\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 10 items\n\ntests/test_response_by_alias.py::test_read_dict PASSED [ 10%]\ntests/test_response_by_alias.py::test_read_model PASSED [ 20%]\ntests/test_response_by_alias.py::test_read_list PASSED [ 30%]\ntests/test_response_by_alias.py::test_read_dict_by_alias PASSED [ 40%]\ntests/test_response_by_alias.py::test_read_model_by_alias PASSED [ 50%]\ntests/test_response_by_alias.py::test_read_list_by_alias PASSED [ 60%]\ntests/test_response_by_alias.py::test_read_dict_no_alias PASSED [ 70%]\ntests/test_response_by_alias.py::test_read_model_no_alias PASSED [ 80%]\ntests/test_response_by_alias.py::test_read_list_no_alias PASSED [ 90%]\ntests/test_response_by_alias.py::test_openapi_schema FAILED [100%]\n\n=================================== FAILURES ===================================\n_____________________________ test_openapi_schema ______________________________\n\n def test_openapi_schema():\n> response = client.get(\"/openapi.json\")\n\ntests/test_response_by_alias.py:150: \n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:551: in get\n return super().get(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:1041: in get\n return self.request(\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:519: in request\n return super().request(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:814: in request\n return self.send(request, auth=auth, follow_redirects=follow_redirects)\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:901: in send\n response = self._send_handling_auth(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:929: in _send_handling_auth\n response = self._send_handling_redirects(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:966: in _send_handling_redirects\n response = self._send_single_request(request)\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:1002: in _send_single_request\n response = transport.handle_request(request)\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:401: in handle_request\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:398: in handle_request\n portal.call(self.app, scope, receive, send)\n../test_venv/lib/python3.11/site-packages/anyio/from_thread.py:277: in call\n return cast(T_Retval, self.start_task_soon(func, *args).result())\n/usr/local/lib/python3.11/concurrent/futures/_base.py:456: in result\n return self.__get_result()\n/usr/local/lib/python3.11/concurrent/futures/_base.py:401: in __get_result\n raise self._exception\n../test_venv/lib/python3.11/site-packages/anyio/from_thread.py:217: in _call_func\n retval = await retval\nfastapi/applications.py:1054: in __call__\n await super().__call__(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/applications.py:123: in __call__\n await self.middleware_stack(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/middleware/errors.py:186: in __call__\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/middleware/errors.py:164: in __call__\n await self.app(scope, receive, _send)\n../test_venv/lib/python3.11/site-packages/starlette/middleware/exceptions.py:65: in __call__\n await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:64: in wrapped_app\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:53: in wrapped_app\n await app(scope, receive, sender)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:754: in __call__\n await self.middleware_stack(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:774: in app\n await route.handle(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:295: in handle\n await self.app(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:77: in app\n await wrap_app_handling_exceptions(app, request)(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:64: in wrapped_app\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:53: in wrapped_app\n await app(scope, receive, sender)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:74: in app\n response = await f(request)\nfastapi/applications.py:1009: in openapi\n return JSONResponse(self.openapi())\nfastapi/applications.py:981: in openapi\n self.openapi_schema = get_openapi(\nfastapi/openapi/utils.py:483: in get_openapi\n result = get_openapi_path(\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n\n def get_openapi_path(\n *,\n route: routing.APIRoute,\n operation_ids: Set[str],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Tuple[Dict[str, Any], Dict[str, Any], Dict[str, Any]]:\n path = {}\n security_schemes: Dict[str, Any] = {}\n definitions: Dict[str, Any] = {}\n assert route.methods is not None, \"Methods must be a list\"\n if isinstance(route.response_class, DefaultPlaceholder):\n current_response_class: Type[Response] = route.response_class.value\n else:\n current_response_class = route.response_class\n assert current_response_class, \"A response class is needed to generate OpenAPI\"\n route_response_media_type: Optional[str] = current_response_class.media_type\n if route.include_in_schema:\n for method in route.methods:\n operation = get_openapi_operation_metadata(\n route=route, method=method, operation_ids=operation_ids\n )\n parameters: List[Dict[str, Any]] = []\n flat_dependant = get_flat_dependant(route.dependant, skip_repeats=True)\n security_definitions, operation_security = get_openapi_security_definitions(\n flat_dependant=flat_dependant\n )\n if operation_security:\n operation.setdefault(\"security\", []).extend(operation_security)\n if security_definitions:\n security_schemes.update(security_definitions)\n all_route_params = get_flat_params(route.dependant)\n operation_parameters = get_openapi_operation_parameters(\n all_route_params=all_route_params,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n field_mapping=field_mapping,\n separate_input_output_schemas=separate_input_output_schemas,\n )\n parameters.extend(operation_parameters)\n if parameters:\n all_parameters = {\n (param[\"in\"], param[\"name\"]): param for param in parameters\n }\n required_parameters = {\n (param[\"in\"], param[\"name\"]): param\n for param in parameters\n if param.get(\"required\")\n }\n # Make sure required definitions of the same parameter take precedence\n # over non-required definitions\n all_parameters.update(required_parameters)\n operation[\"parameters\"] = list(all_parameters.values())\n if method in METHODS_WITH_BODY:\n request_body_oai = get_openapi_operation_request_body(\n body_field=route.body_field,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n field_mapping=field_mapping,\n separate_input_output_schemas=separate_input_output_schemas,\n )\n if request_body_oai:\n operation[\"requestBody\"] = request_body_oai\n if route.callbacks:\n callbacks = {}\n for callback in route.callbacks:\n if isinstance(callback, routing.APIRoute):\n (\n cb_path,\n cb_security_schemes,\n cb_definitions,\n ) = get_openapi_path(\n route=callback,\n operation_ids=operation_ids,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n field_mapping=field_mapping,\n separate_input_output_schemas=separate_input_output_schemas,\n )\n callbacks[callback.name] = {callback.path: cb_path}\n operation[\"callbacks\"] = callbacks\n if route.status_code is not None:\n status_code = str(route.status_code)\n else:\n # It would probably make more sense for all response classes to have an\n # explicit default status_code, and to extract it from them, instead of\n # doing this inspection tricks, that would probably be in the future\n # TODO: probably make status_code a default class attribute for all\n # responses in Starlette\n response_signature = inspect.signature(current_response_class.__init__)\n status_code_param = response_signature.parameters.get(\"status_code\")\n if status_code_param is not None:\n if isinstance(status_code_param.default, int):\n status_code = str(status_code_param.default)\n operation.setdefault(\"responses\", {}).setdefault(status_code, {})[\n \"description\"\n ] = route.response_description\n if route_response_media_type and is_body_allowed_for_status_code(\n route.status_code\n ):\n response_schema = {\"type\": \"string\"}\n if lenient_issubclass(current_response_class, JSONResponse):\n if route.response_field:\n> response_schema = get_schema_from_model_field(\n field=route.response_field,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n field_mapping=field_mapping,\n separate_input_output_schemas=separate_input_output_schemas,\n )\nE TypeError: get_schema_from_model_field() got an unexpected keyword argument 'separate_input_output_schemas'\n\nfastapi/openapi/utils.py:322: TypeError\n=========================== short test summary info ============================\nFAILED tests/test_response_by_alias.py::test_openapi_schema - TypeError: get_...\n========================= 1 failed, 9 passed in 0.95s ==========================\n"},"gold_summary":{"kind":"string","value":"{'total': 10, 'passed': 10, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 10, 'passed': 9, 'xpassed': 0, 'failed': 1, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/_compat.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_response_by_alias.py"}}},{"rowIdx":94,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee___compat__get_definitions__0976185af96ab2ee39c949c0456be616b01f8669"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"0976185af96ab2ee39c949c0456be616b01f8669"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"get_definitions"},"pyfile_name":{"kind":"string","value":"_compat.py"},"original_code":{"kind":"string","value":"def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n]:\n inputs = [\n (field, field.mode, field._type_adapter.core_schema) for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions\n"},"gold_code":{"kind":"string","value":"def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n inputs = [\n (field, override_mode or field.mode, field._type_adapter.core_schema)\n for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions\n"},"old_filtered_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as PYDANTIC_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import MultiHostUrl as MultiHostUrl\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n from pydantic_core.core_schema import (\n general_plain_validator_function as general_plain_validator_function,\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\n \"title\"\n ] = field.field_info.title or field.alias.title().replace(\"_\", \" \")\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def general_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"old_complete_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as PYDANTIC_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import MultiHostUrl as MultiHostUrl\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n from pydantic_core.core_schema import (\n general_plain_validator_function as general_plain_validator_function,\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\n \"title\"\n ] = field.field_info.title or field.alias.title().replace(\"_\", \" \")\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n inputs = [\n (field, field.mode, field._type_adapter.core_schema) for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions # type: ignore[return-value]\n\n def is_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n return field_annotation_is_scalar(\n field.field_info.annotation\n ) and not isinstance(field.field_info, params.Body)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_sequence(field.field_info.annotation)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_scalar_sequence(field.field_info.annotation)\n\n def is_bytes_field(field: ModelField) -> bool:\n return is_bytes_or_nonable_bytes_annotation(field.type_)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return is_bytes_sequence_annotation(field.type_)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return type(field_info).from_annotation(annotation)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n origin_type = (\n get_origin(\n field.field_info.annotation) or field.field_info.annotation\n )\n # type: ignore[arg-type]\n assert issubclass(origin_type, sequence_types)\n # type: ignore[no-any-return]\n return sequence_annotation_to_type[origin_type](value)\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n error = ValidationError.from_exception_data(\n \"Field required\", [{\"type\": \"missing\", \"loc\": loc, \"input\": {}}]\n ).errors()[0]\n error[\"input\"] = None\n return error # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n field_params = {\n f.name: (f.field_info.annotation, f.field_info) for f in fields}\n BodyModel: Type[BaseModel] = create_model(\n model_name, **field_params) # type: ignore[call-overload]\n return BodyModel\n\nelse:\n from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX\n from pydantic import AnyUrl as Url # noqa: F401\n from pydantic import ( # type: ignore[assignment]\n BaseConfig as BaseConfig, # noqa: F401\n )\n from pydantic import ValidationError as ValidationError # noqa: F401\n from pydantic.class_validators import ( # type: ignore[no-redef]\n Validator as Validator, # noqa: F401\n )\n from pydantic.error_wrappers import ( # type: ignore[no-redef]\n ErrorWrapper as ErrorWrapper, # noqa: F401\n )\n from pydantic.errors import MissingError\n from pydantic.fields import ( # type: ignore[attr-defined]\n SHAPE_FROZENSET,\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n )\n from pydantic.fields import FieldInfo as FieldInfo\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n ModelField as ModelField, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Required as Required, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Undefined as Undefined,\n )\n from pydantic.fields import ( # type: ignore[no-redef, attr-defined]\n UndefinedType as UndefinedType, # noqa: F401\n )\n from pydantic.networks import ( # type: ignore[no-redef]\n MultiHostDsn as MultiHostUrl, # noqa: F401\n )\n from pydantic.schema import (\n field_schema,\n get_flat_models_from_fields,\n get_model_name_map,\n model_process_schema,\n )\n from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401\n get_annotation_from_field_info as get_annotation_from_field_info,\n )\n from pydantic.typing import ( # type: ignore[no-redef]\n evaluate_forwardref as evaluate_forwardref, # noqa: F401\n )\n from pydantic.utils import ( # type: ignore[no-redef]\n lenient_issubclass as lenient_issubclass, # noqa: F401\n )\n\n GetJsonSchemaHandler = Any # type: ignore[assignment,misc]\n JsonSchemaValue = Dict[str, Any] # type: ignore[misc]\n CoreSchema = Any # type: ignore[assignment,misc]\n\n sequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_FROZENSET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n }\n sequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n }\n\n @dataclass\n class GenerateJsonSchema: # type: ignore[no-redef]\n ref_template: str\n\n class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]\n pass\n\n def general_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n models = get_flat_models_from_fields(fields, known_models=set())\n return {}, get_model_definitions(\n flat_models=models, model_name_map=model_name_map\n )\n\n def is_scalar_field(field: ModelField) -> bool:\n return is_pv1_scalar_field(field)\n\n def is_sequence_field(field: ModelField) -> bool:\n # type: ignore[attr-defined]\n return field.shape in sequence_shapes or _annotation_is_sequence(field.type_)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return is_pv1_scalar_sequence_field(field)\n\n def is_bytes_field(field: ModelField) -> bool:\n return lenient_issubclass(field.type_, bytes)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n # type: ignore[attr-defined]\n return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return copy(field_info)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n # type: ignore[no-any-return,attr-defined]\n return sequence_shape_to_type[field.shape](value)\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n missing_field_error = ErrorWrapper(\n MissingError(), loc=loc) # type: ignore[call-arg]\n new_error = ValidationError([missing_field_error], RequestErrorModel)\n return new_error.errors()[0] # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n BodyModel = create_model(model_name)\n for f in fields:\n BodyModel.__fields__[f.name] = f # type: ignore[index]\n return BodyModel\n\n\ndef _regenerate_error_with_loc(\n *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]\n) -> List[Dict[str, Any]]:\n updated_loc_errors: List[Any] = [\n {**err, \"loc\": loc_prefix + err.get(\"loc\", ())}\n for err in _normalize_errors(errors)\n ]\n\n return updated_loc_errors\n\n\ndef _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n if lenient_issubclass(annotation, (str, bytes)):\n return False\n return lenient_issubclass(annotation, sequence_types)\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"new_filtered_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as P_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\n# Reassign variable to make it reexported for mypy\nPYDANTIC_VERSION = P_VERSION\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n\n try:\n from pydantic_core.core_schema import (\n with_info_plain_validator_function as with_info_plain_validator_function,\n )\n except ImportError: # pragma: no cover\n from pydantic_core.core_schema import (\n general_plain_validator_function as with_info_plain_validator_function, # noqa: F401\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(\n value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(include_url=False), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, override_mode or field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\"title\"] = (\n field.field_info.title or field.alias.title().replace(\"_\", \" \")\n )\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def with_info_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[\n 0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n # type: ignore[attr-defined]\n for sub_field in field.sub_fields:\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\",\n \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if field_annotation_is_sequence(arg):\n return True\n return False\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n # type: ignore[arg-type]\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes))\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"new_complete_context":{"kind":"string","value":"from collections import deque\nfrom copy import copy\nfrom dataclasses import dataclass, is_dataclass\nfrom enum import Enum\nfrom typing import (\n Any,\n Callable,\n Deque,\n Dict,\n FrozenSet,\n List,\n Mapping,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi.exceptions import RequestErrorModel\nfrom fastapi.types import IncEx, ModelNameMap, UnionType\nfrom pydantic import BaseModel, create_model\nfrom pydantic.version import VERSION as P_VERSION\nfrom starlette.datastructures import UploadFile\nfrom typing_extensions import Annotated, Literal, get_args, get_origin\n\n# Reassign variable to make it reexported for mypy\nPYDANTIC_VERSION = P_VERSION\nPYDANTIC_V2 = PYDANTIC_VERSION.startswith(\"2.\")\n\n\nsequence_annotation_to_type = {\n Sequence: list,\n List: list,\n list: list,\n Tuple: tuple,\n tuple: tuple,\n Set: set,\n set: set,\n FrozenSet: frozenset,\n frozenset: frozenset,\n Deque: deque,\n deque: deque,\n}\n\nsequence_types = tuple(sequence_annotation_to_type.keys())\n\nif PYDANTIC_V2:\n from pydantic import PydanticSchemaGenerationError as PydanticSchemaGenerationError\n from pydantic import TypeAdapter\n from pydantic import ValidationError as ValidationError\n from pydantic._internal._schema_generation_shared import ( # type: ignore[attr-defined]\n GetJsonSchemaHandler as GetJsonSchemaHandler,\n )\n from pydantic._internal._typing_extra import eval_type_lenient\n from pydantic._internal._utils import lenient_issubclass as lenient_issubclass\n from pydantic.fields import FieldInfo\n from pydantic.json_schema import GenerateJsonSchema as GenerateJsonSchema\n from pydantic.json_schema import JsonSchemaValue as JsonSchemaValue\n from pydantic_core import CoreSchema as CoreSchema\n from pydantic_core import PydanticUndefined, PydanticUndefinedType\n from pydantic_core import Url as Url\n\n try:\n from pydantic_core.core_schema import (\n with_info_plain_validator_function as with_info_plain_validator_function,\n )\n except ImportError: # pragma: no cover\n from pydantic_core.core_schema import (\n general_plain_validator_function as with_info_plain_validator_function, # noqa: F401\n )\n\n Required = PydanticUndefined\n Undefined = PydanticUndefined\n UndefinedType = PydanticUndefinedType\n evaluate_forwardref = eval_type_lenient\n Validator = Any\n\n class BaseConfig:\n pass\n\n class ErrorWrapper(Exception):\n pass\n\n @dataclass\n class ModelField:\n field_info: FieldInfo\n name: str\n mode: Literal[\"validation\", \"serialization\"] = \"validation\"\n\n @property\n def alias(self) -> str:\n a = self.field_info.alias\n return a if a is not None else self.name\n\n @property\n def required(self) -> bool:\n return self.field_info.is_required()\n\n @property\n def default(self) -> Any:\n return self.get_default()\n\n @property\n def type_(self) -> Any:\n return self.field_info.annotation\n\n def __post_init__(self) -> None:\n self._type_adapter: TypeAdapter[Any] = TypeAdapter(\n Annotated[self.field_info.annotation, self.field_info]\n )\n\n def get_default(self) -> Any:\n if self.field_info.is_required():\n return Undefined\n return self.field_info.get_default(call_default_factory=True)\n\n def validate(\n self,\n value: Any,\n values: Dict[str, Any] = {}, # noqa: B006\n *,\n loc: Tuple[Union[int, str], ...] = (),\n ) -> Tuple[Any, Union[List[Dict[str, Any]], None]]:\n try:\n return (\n self._type_adapter.validate_python(value, from_attributes=True),\n None,\n )\n except ValidationError as exc:\n return None, _regenerate_error_with_loc(\n errors=exc.errors(include_url=False), loc_prefix=loc\n )\n\n def serialize(\n self,\n value: Any,\n *,\n mode: Literal[\"json\", \"python\"] = \"json\",\n include: Union[IncEx, None] = None,\n exclude: Union[IncEx, None] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n ) -> Any:\n # What calls this code passes a value that already called\n # self._type_adapter.validate_python(value)\n return self._type_adapter.dump_python(\n value,\n mode=mode,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n def __hash__(self) -> int:\n # Each ModelField is unique for our purposes, to allow making a dict from\n # ModelField to its JSON Schema.\n return id(self)\n\n def get_annotation_from_field_info(\n annotation: Any, field_info: FieldInfo, field_name: str\n ) -> Any:\n return annotation\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n return errors # type: ignore[return-value]\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.model_rebuild()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.model_dump(mode=mode, **kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.model_config\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n # This expects that GenerateJsonSchema was already used to generate the definitions\n json_schema = field_mapping[(field, override_mode or field.mode)]\n if \"$ref\" not in json_schema:\n # TODO remove when deprecating Pydantic v1\n # Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207\n json_schema[\"title\"] = (\n field.field_info.title or field.alias.title().replace(\"_\", \" \")\n )\n return json_schema\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n return {}\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n override_mode: Union[Literal[\"validation\"], None] = (\n None if separate_input_output_schemas else \"validation\"\n )\n inputs = [\n (field, override_mode or field.mode, field._type_adapter.core_schema)\n for field in fields\n ]\n field_mapping, definitions = schema_generator.generate_definitions(\n inputs=inputs\n )\n return field_mapping, definitions # type: ignore[return-value]\n\n def is_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n return field_annotation_is_scalar(\n field.field_info.annotation\n ) and not isinstance(field.field_info, params.Body)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_sequence(field.field_info.annotation)\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return field_annotation_is_scalar_sequence(field.field_info.annotation)\n\n def is_bytes_field(field: ModelField) -> bool:\n return is_bytes_or_nonable_bytes_annotation(field.type_)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return is_bytes_sequence_annotation(field.type_)\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n cls = type(field_info)\n merged_field_info = cls.from_annotation(annotation)\n new_field_info = copy(field_info)\n new_field_info.metadata = merged_field_info.metadata\n new_field_info.annotation = merged_field_info.annotation\n return new_field_info\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n origin_type = (\n get_origin(field.field_info.annotation) or field.field_info.annotation\n )\n assert issubclass(origin_type, sequence_types) # type: ignore[arg-type]\n return sequence_annotation_to_type[origin_type](value) # type: ignore[no-any-return]\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n error = ValidationError.from_exception_data(\n \"Field required\", [{\"type\": \"missing\", \"loc\": loc, \"input\": {}}]\n ).errors(include_url=False)[0]\n error[\"input\"] = None\n return error # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n field_params = {f.name: (f.field_info.annotation, f.field_info) for f in fields}\n BodyModel: Type[BaseModel] = create_model(model_name, **field_params) # type: ignore[call-overload]\n return BodyModel\n\n def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:\n return [\n ModelField(field_info=field_info, name=name)\n for name, field_info in model.model_fields.items()\n ]\n\nelse:\n from fastapi.openapi.constants import REF_PREFIX as REF_PREFIX\n from pydantic import AnyUrl as Url # noqa: F401\n from pydantic import ( # type: ignore[assignment]\n BaseConfig as BaseConfig, # noqa: F401\n )\n from pydantic import ValidationError as ValidationError # noqa: F401\n from pydantic.class_validators import ( # type: ignore[no-redef]\n Validator as Validator, # noqa: F401\n )\n from pydantic.error_wrappers import ( # type: ignore[no-redef]\n ErrorWrapper as ErrorWrapper, # noqa: F401\n )\n from pydantic.errors import MissingError\n from pydantic.fields import ( # type: ignore[attr-defined]\n SHAPE_FROZENSET,\n SHAPE_LIST,\n SHAPE_SEQUENCE,\n SHAPE_SET,\n SHAPE_SINGLETON,\n SHAPE_TUPLE,\n SHAPE_TUPLE_ELLIPSIS,\n )\n from pydantic.fields import FieldInfo as FieldInfo\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n ModelField as ModelField, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Required as Required, # noqa: F401\n )\n from pydantic.fields import ( # type: ignore[no-redef,attr-defined]\n Undefined as Undefined,\n )\n from pydantic.fields import ( # type: ignore[no-redef, attr-defined]\n UndefinedType as UndefinedType, # noqa: F401\n )\n from pydantic.schema import (\n field_schema,\n get_flat_models_from_fields,\n get_model_name_map,\n model_process_schema,\n )\n from pydantic.schema import ( # type: ignore[no-redef] # noqa: F401\n get_annotation_from_field_info as get_annotation_from_field_info,\n )\n from pydantic.typing import ( # type: ignore[no-redef]\n evaluate_forwardref as evaluate_forwardref, # noqa: F401\n )\n from pydantic.utils import ( # type: ignore[no-redef]\n lenient_issubclass as lenient_issubclass, # noqa: F401\n )\n\n GetJsonSchemaHandler = Any # type: ignore[assignment,misc]\n JsonSchemaValue = Dict[str, Any] # type: ignore[misc]\n CoreSchema = Any # type: ignore[assignment,misc]\n\n sequence_shapes = {\n SHAPE_LIST,\n SHAPE_SET,\n SHAPE_FROZENSET,\n SHAPE_TUPLE,\n SHAPE_SEQUENCE,\n SHAPE_TUPLE_ELLIPSIS,\n }\n sequence_shape_to_type = {\n SHAPE_LIST: list,\n SHAPE_SET: set,\n SHAPE_TUPLE: tuple,\n SHAPE_SEQUENCE: list,\n SHAPE_TUPLE_ELLIPSIS: list,\n }\n\n @dataclass\n class GenerateJsonSchema: # type: ignore[no-redef]\n ref_template: str\n\n class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]\n pass\n\n def with_info_plain_validator_function( # type: ignore[misc]\n function: Callable[..., Any],\n *,\n ref: Union[str, None] = None,\n metadata: Any = None,\n serialization: Any = None,\n ) -> Any:\n return {}\n\n def get_model_definitions(\n *,\n flat_models: Set[Union[Type[BaseModel], Type[Enum]]],\n model_name_map: Dict[Union[Type[BaseModel], Type[Enum]], str],\n ) -> Dict[str, Any]:\n definitions: Dict[str, Dict[str, Any]] = {}\n for model in flat_models:\n m_schema, m_definitions, m_nested_models = model_process_schema(\n model, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )\n definitions.update(m_definitions)\n model_name = model_name_map[model]\n if \"description\" in m_schema:\n m_schema[\"description\"] = m_schema[\"description\"].split(\"\\f\")[0]\n definitions[model_name] = m_schema\n return definitions\n\n def is_pv1_scalar_field(field: ModelField) -> bool:\n from fastapi import params\n\n field_info = field.field_info\n if not (\n field.shape == SHAPE_SINGLETON # type: ignore[attr-defined]\n and not lenient_issubclass(field.type_, BaseModel)\n and not lenient_issubclass(field.type_, dict)\n and not field_annotation_is_sequence(field.type_)\n and not is_dataclass(field.type_)\n and not isinstance(field_info, params.Body)\n ):\n return False\n if field.sub_fields: # type: ignore[attr-defined]\n if not all(\n is_pv1_scalar_field(f)\n for f in field.sub_fields # type: ignore[attr-defined]\n ):\n return False\n return True\n\n def is_pv1_scalar_sequence_field(field: ModelField) -> bool:\n if (field.shape in sequence_shapes) and not lenient_issubclass( # type: ignore[attr-defined]\n field.type_, BaseModel\n ):\n if field.sub_fields is not None: # type: ignore[attr-defined]\n for sub_field in field.sub_fields: # type: ignore[attr-defined]\n if not is_pv1_scalar_field(sub_field):\n return False\n return True\n if _annotation_is_sequence(field.type_):\n return True\n return False\n\n def _normalize_errors(errors: Sequence[Any]) -> List[Dict[str, Any]]:\n use_errors: List[Any] = []\n for error in errors:\n if isinstance(error, ErrorWrapper):\n new_errors = ValidationError( # type: ignore[call-arg]\n errors=[error], model=RequestErrorModel\n ).errors()\n use_errors.extend(new_errors)\n elif isinstance(error, list):\n use_errors.extend(_normalize_errors(error))\n else:\n use_errors.append(error)\n return use_errors\n\n def _model_rebuild(model: Type[BaseModel]) -> None:\n model.update_forward_refs()\n\n def _model_dump(\n model: BaseModel, mode: Literal[\"json\", \"python\"] = \"json\", **kwargs: Any\n ) -> Any:\n return model.dict(**kwargs)\n\n def _get_model_config(model: BaseModel) -> Any:\n return model.__config__ # type: ignore[attr-defined]\n\n def get_schema_from_model_field(\n *,\n field: ModelField,\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n field_mapping: Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n # This expects that GenerateJsonSchema was already used to generate the definitions\n return field_schema( # type: ignore[no-any-return]\n field, model_name_map=model_name_map, ref_prefix=REF_PREFIX\n )[0]\n\n def get_compat_model_name_map(fields: List[ModelField]) -> ModelNameMap:\n models = get_flat_models_from_fields(fields, known_models=set())\n return get_model_name_map(models) # type: ignore[no-any-return]\n\n def get_definitions(\n *,\n fields: List[ModelField],\n schema_generator: GenerateJsonSchema,\n model_name_map: ModelNameMap,\n separate_input_output_schemas: bool = True,\n ) -> Tuple[\n Dict[\n Tuple[ModelField, Literal[\"validation\", \"serialization\"]], JsonSchemaValue\n ],\n Dict[str, Dict[str, Any]],\n ]:\n models = get_flat_models_from_fields(fields, known_models=set())\n return {}, get_model_definitions(\n flat_models=models, model_name_map=model_name_map\n )\n\n def is_scalar_field(field: ModelField) -> bool:\n return is_pv1_scalar_field(field)\n\n def is_sequence_field(field: ModelField) -> bool:\n return field.shape in sequence_shapes or _annotation_is_sequence(field.type_) # type: ignore[attr-defined]\n\n def is_scalar_sequence_field(field: ModelField) -> bool:\n return is_pv1_scalar_sequence_field(field)\n\n def is_bytes_field(field: ModelField) -> bool:\n return lenient_issubclass(field.type_, bytes)\n\n def is_bytes_sequence_field(field: ModelField) -> bool:\n return field.shape in sequence_shapes and lenient_issubclass(field.type_, bytes) # type: ignore[attr-defined]\n\n def copy_field_info(*, field_info: FieldInfo, annotation: Any) -> FieldInfo:\n return copy(field_info)\n\n def serialize_sequence_value(*, field: ModelField, value: Any) -> Sequence[Any]:\n return sequence_shape_to_type[field.shape](value) # type: ignore[no-any-return,attr-defined]\n\n def get_missing_field_error(loc: Tuple[str, ...]) -> Dict[str, Any]:\n missing_field_error = ErrorWrapper(MissingError(), loc=loc) # type: ignore[call-arg]\n new_error = ValidationError([missing_field_error], RequestErrorModel)\n return new_error.errors()[0] # type: ignore[return-value]\n\n def create_body_model(\n *, fields: Sequence[ModelField], model_name: str\n ) -> Type[BaseModel]:\n BodyModel = create_model(model_name)\n for f in fields:\n BodyModel.__fields__[f.name] = f # type: ignore[index]\n return BodyModel\n\n def get_model_fields(model: Type[BaseModel]) -> List[ModelField]:\n return list(model.__fields__.values()) # type: ignore[attr-defined]\n\n\ndef _regenerate_error_with_loc(\n *, errors: Sequence[Any], loc_prefix: Tuple[Union[str, int], ...]\n) -> List[Dict[str, Any]]:\n updated_loc_errors: List[Any] = [\n {**err, \"loc\": loc_prefix + err.get(\"loc\", ())}\n for err in _normalize_errors(errors)\n ]\n\n return updated_loc_errors\n\n\ndef _annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n if lenient_issubclass(annotation, (str, bytes)):\n return False\n return lenient_issubclass(annotation, sequence_types)\n\n\ndef field_annotation_is_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if field_annotation_is_sequence(arg):\n return True\n return False\n return _annotation_is_sequence(annotation) or _annotation_is_sequence(\n get_origin(annotation)\n )\n\n\ndef value_is_sequence(value: Any) -> bool:\n return isinstance(value, sequence_types) and not isinstance(value, (str, bytes)) # type: ignore[arg-type]\n\n\ndef _annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n return (\n lenient_issubclass(annotation, (BaseModel, Mapping, UploadFile))\n or _annotation_is_sequence(annotation)\n or is_dataclass(annotation)\n )\n\n\ndef field_annotation_is_complex(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n return any(field_annotation_is_complex(arg) for arg in get_args(annotation))\n\n return (\n _annotation_is_complex(annotation)\n or _annotation_is_complex(origin)\n or hasattr(origin, \"__pydantic_core_schema__\")\n or hasattr(origin, \"__get_pydantic_core_schema__\")\n )\n\n\ndef field_annotation_is_scalar(annotation: Any) -> bool:\n # handle Ellipsis here to make tuple[int, ...] work nicely\n return annotation is Ellipsis or not field_annotation_is_complex(annotation)\n\n\ndef field_annotation_is_scalar_sequence(annotation: Union[Type[Any], None]) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one_scalar_sequence = False\n for arg in get_args(annotation):\n if field_annotation_is_scalar_sequence(arg):\n at_least_one_scalar_sequence = True\n continue\n elif not field_annotation_is_scalar(arg):\n return False\n return at_least_one_scalar_sequence\n return field_annotation_is_sequence(annotation) and all(\n field_annotation_is_scalar(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_bytes_or_nonable_bytes_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, bytes):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, bytes):\n return True\n return False\n\n\ndef is_uploadfile_or_nonable_uploadfile_annotation(annotation: Any) -> bool:\n if lenient_issubclass(annotation, UploadFile):\n return True\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n for arg in get_args(annotation):\n if lenient_issubclass(arg, UploadFile):\n return True\n return False\n\n\ndef is_bytes_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_bytes_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_bytes_or_nonable_bytes_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n\n\ndef is_uploadfile_sequence_annotation(annotation: Any) -> bool:\n origin = get_origin(annotation)\n if origin is Union or origin is UnionType:\n at_least_one = False\n for arg in get_args(annotation):\n if is_uploadfile_sequence_annotation(arg):\n at_least_one = True\n continue\n return at_least_one\n return field_annotation_is_sequence(annotation) and all(\n is_uploadfile_or_nonable_uploadfile_annotation(sub_annotation)\n for sub_annotation in get_args(annotation)\n )\n"},"initial_error_log":{"kind":"string","value":"============================= test session starts ==============================\nplatform linux -- Python 3.11.9, pytest-8.3.2, pluggy-1.5.0 -- /workspace/test_venv/bin/python\ncachedir: .pytest_cache\nrootdir: /workspace/test_repo\nconfigfile: pyproject.toml\nplugins: anyio-3.7.1, asyncio-0.24.0\nasyncio: mode=Mode.STRICT, default_loop_scope=function\ncollecting ... collected 10 items\n\ntests/test_response_by_alias.py::test_read_dict PASSED [ 10%]\ntests/test_response_by_alias.py::test_read_model PASSED [ 20%]\ntests/test_response_by_alias.py::test_read_list PASSED [ 30%]\ntests/test_response_by_alias.py::test_read_dict_by_alias PASSED [ 40%]\ntests/test_response_by_alias.py::test_read_model_by_alias PASSED [ 50%]\ntests/test_response_by_alias.py::test_read_list_by_alias PASSED [ 60%]\ntests/test_response_by_alias.py::test_read_dict_no_alias PASSED [ 70%]\ntests/test_response_by_alias.py::test_read_model_no_alias PASSED [ 80%]\ntests/test_response_by_alias.py::test_read_list_no_alias PASSED [ 90%]\ntests/test_response_by_alias.py::test_openapi_schema FAILED [100%]\n\n=================================== FAILURES ===================================\n_____________________________ test_openapi_schema ______________________________\n\n def test_openapi_schema():\n> response = client.get(\"/openapi.json\")\n\ntests/test_response_by_alias.py:150: \n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:551: in get\n return super().get(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:1041: in get\n return self.request(\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:519: in request\n return super().request(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:814: in request\n return self.send(request, auth=auth, follow_redirects=follow_redirects)\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:901: in send\n response = self._send_handling_auth(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:929: in _send_handling_auth\n response = self._send_handling_redirects(\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:966: in _send_handling_redirects\n response = self._send_single_request(request)\n../test_venv/lib/python3.11/site-packages/httpx/_client.py:1002: in _send_single_request\n response = transport.handle_request(request)\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:401: in handle_request\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/testclient.py:398: in handle_request\n portal.call(self.app, scope, receive, send)\n../test_venv/lib/python3.11/site-packages/anyio/from_thread.py:277: in call\n return cast(T_Retval, self.start_task_soon(func, *args).result())\n/usr/local/lib/python3.11/concurrent/futures/_base.py:449: in result\n return self.__get_result()\n/usr/local/lib/python3.11/concurrent/futures/_base.py:401: in __get_result\n raise self._exception\n../test_venv/lib/python3.11/site-packages/anyio/from_thread.py:217: in _call_func\n retval = await retval\nfastapi/applications.py:1054: in __call__\n await super().__call__(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/applications.py:123: in __call__\n await self.middleware_stack(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/middleware/errors.py:186: in __call__\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/middleware/errors.py:164: in __call__\n await self.app(scope, receive, _send)\n../test_venv/lib/python3.11/site-packages/starlette/middleware/exceptions.py:65: in __call__\n await wrap_app_handling_exceptions(self.app, conn)(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:64: in wrapped_app\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:53: in wrapped_app\n await app(scope, receive, sender)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:754: in __call__\n await self.middleware_stack(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:774: in app\n await route.handle(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:295: in handle\n await self.app(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:77: in app\n await wrap_app_handling_exceptions(app, request)(scope, receive, send)\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:64: in wrapped_app\n raise exc\n../test_venv/lib/python3.11/site-packages/starlette/_exception_handler.py:53: in wrapped_app\n await app(scope, receive, sender)\n../test_venv/lib/python3.11/site-packages/starlette/routing.py:74: in app\n response = await f(request)\nfastapi/applications.py:1009: in openapi\n return JSONResponse(self.openapi())\nfastapi/applications.py:981: in openapi\n self.openapi_schema = get_openapi(\n_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ \n\n def get_openapi(\n *,\n title: str,\n version: str,\n openapi_version: str = \"3.1.0\",\n summary: Optional[str] = None,\n description: Optional[str] = None,\n routes: Sequence[BaseRoute],\n webhooks: Optional[Sequence[BaseRoute]] = None,\n tags: Optional[List[Dict[str, Any]]] = None,\n servers: Optional[List[Dict[str, Union[str, Any]]]] = None,\n terms_of_service: Optional[str] = None,\n contact: Optional[Dict[str, Union[str, Any]]] = None,\n license_info: Optional[Dict[str, Union[str, Any]]] = None,\n separate_input_output_schemas: bool = True,\n ) -> Dict[str, Any]:\n info: Dict[str, Any] = {\"title\": title, \"version\": version}\n if summary:\n info[\"summary\"] = summary\n if description:\n info[\"description\"] = description\n if terms_of_service:\n info[\"termsOfService\"] = terms_of_service\n if contact:\n info[\"contact\"] = contact\n if license_info:\n info[\"license\"] = license_info\n output: Dict[str, Any] = {\"openapi\": openapi_version, \"info\": info}\n if servers:\n output[\"servers\"] = servers\n components: Dict[str, Dict[str, Any]] = {}\n paths: Dict[str, Dict[str, Any]] = {}\n webhook_paths: Dict[str, Dict[str, Any]] = {}\n operation_ids: Set[str] = set()\n all_fields = get_fields_from_routes(list(routes or []) + list(webhooks or []))\n model_name_map = get_compat_model_name_map(all_fields)\n schema_generator = GenerateJsonSchema(ref_template=REF_TEMPLATE)\n> field_mapping, definitions = get_definitions(\n fields=all_fields,\n schema_generator=schema_generator,\n model_name_map=model_name_map,\n separate_input_output_schemas=separate_input_output_schemas,\n )\nE TypeError: get_definitions() got an unexpected keyword argument 'separate_input_output_schemas'\n\nfastapi/openapi/utils.py:475: TypeError\n=========================== short test summary info ============================\nFAILED tests/test_response_by_alias.py::test_openapi_schema - TypeError: get_...\n========================= 1 failed, 9 passed in 0.90s ==========================\n"},"gold_summary":{"kind":"string","value":"{'total': 10, 'passed': 10, 'xpassed': 0, 'failed': 0, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"original_summary":{"kind":"string","value":"{'total': 10, 'passed': 9, 'xpassed': 0, 'failed': 1, 'xfailed': 0, 'deselected': 0, 'skipped': 0, 'warning': 0, 'error': 0}"},"pyfile_path":{"kind":"string","value":"./test_repo/fastapi/_compat.py"},"unittest_path":{"kind":"string","value":"./test_repo/tests/test_response_by_alias.py"}}},{"rowIdx":95,"cells":{"instance_id":{"kind":"string","value":"1_fastapi_callee__routing___prepare_response_content__aea04ee32ee1942e6e1a904527bb8da6ba76abd9"},"instance_type":{"kind":"string","value":"callee"},"task_type":{"kind":"string","value":"fail-to-pass"},"repo_url":{"kind":"string","value":"https://github.com/fastapi/fastapi"},"commit":{"kind":"string","value":"aea04ee32ee1942e6e1a904527bb8da6ba76abd9"},"fm_type":{"kind":"string","value":"function"},"fm_name":{"kind":"string","value":"_prepare_response_content"},"pyfile_name":{"kind":"string","value":"routing.py"},"original_code":{"kind":"string","value":"def _prepare_response_content(\n res: Any, *, by_alias: bool = True, exclude_unset: bool\n) -> Any:\n if isinstance(res, BaseModel):\n if PYDANTIC_1:\n return res.dict(by_alias=by_alias, exclude_unset=exclude_unset)\n else:\n return res.dict(\n by_alias=by_alias, skip_defaults=exclude_unset\n ) # pragma: nocover\n elif isinstance(res, list):\n return [\n _prepare_response_content(item, exclude_unset=exclude_unset) for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(v, exclude_unset=exclude_unset)\n for k, v in res.items()\n }\n return res\n"},"gold_code":{"kind":"string","value":"def _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(\n _get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n"},"old_filtered_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Set, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import STATUS_CODES_WITH_NO_BODY\nfrom fastapi.utils import (\n PYDANTIC_1,\n create_cloned_field,\n create_response_field,\n generate_operation_id_for_path,\n get_field_info,\n warning_response_model_skip_defaults_deprecated,\n)\nfrom pydantic import BaseModel\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import Mount # noqa\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp\nfrom starlette.websockets import WebSocket\n\ntry:\n from pydantic.fields import FieldInfo, ModelField\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic import Schema as FieldInfo # type: ignore\n from pydantic.fields import Field as ModelField # type: ignore\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: ModelField = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: ModelField = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n dependency_overrides_provider: Any = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n get_field_info(body_field), params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logger.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors, body=body)\n else:\n raw_response = await run_endpoint_function(\n dependant=dependant, values=values, is_coroutine=is_coroutine\n )\n\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n is_coroutine=is_coroutine,\n )\n response = response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Any = None\n) -> Callable:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n name: str = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Optional[Type[Response]] = None,\n dependency_overrides_provider: Any = None,\n callbacks: Optional[List[\"APIRoute\"]] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods = set([method.upper() for method in methods])\n self.unique_id = generate_operation_id_for_path(\n name=self.name, path=self.path_format, method=list(methods)[0]\n )\n self.response_model = response_model\n if self.response_model:\n assert (\n status_code not in STATUS_CODES_WITH_NO_BODY\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_response_field(\n name=response_name, type_=self.response_model\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[\n ModelField\n ] = create_cloned_field(self.response_field)\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.status_code = status_code\n self.tags = tags or []\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0]\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert (\n additional_status_code not in STATUS_CODES_WITH_NO_BODY\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_response_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n assert callable(endpoint), f\"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class or JSONResponse,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n routes: List[routing.BaseRoute] = None,\n redirect_slashes: bool = True,\n default: ASGIApp = None,\n dependency_overrides_provider: Any = None,\n route_class: Type[APIRoute] = APIRoute,\n default_response_class: Type[Response] = None,\n on_startup: Sequence[Callable] = None,\n on_shutdown: Sequence[Callable] = None,\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n )\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: List[APIRoute] = None,\n ) -> None:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n route_class = route_class_override or self.route_class\n route = route_class(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=callbacks,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n default_response_class: Optional[Type[Response]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\")\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=list(dependencies or [])\n + list(route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class or default_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=route.callbacks,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=list(route.methods or []),\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n"},"old_complete_context":{"kind":"string","value":"import asyncio\nimport inspect\nfrom typing import Any, Callable, Dict, List, Optional, Sequence, Set, Type, Union\n\nfrom fastapi import params\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n get_body_field,\n get_dependant,\n get_parameterless_sub_dependant,\n solve_dependencies,\n)\nfrom fastapi.encoders import DictIntStrAny, SetIntStr, jsonable_encoder\nfrom fastapi.exceptions import RequestValidationError, WebSocketRequestValidationError\nfrom fastapi.logger import logger\nfrom fastapi.openapi.constants import STATUS_CODES_WITH_NO_BODY\nfrom fastapi.utils import (\n PYDANTIC_1,\n create_cloned_field,\n create_response_field,\n generate_operation_id_for_path,\n get_field_info,\n warning_response_model_skip_defaults_deprecated,\n)\nfrom pydantic import BaseModel\nfrom pydantic.error_wrappers import ErrorWrapper, ValidationError\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import Mount # noqa\nfrom starlette.routing import (\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.status import WS_1008_POLICY_VIOLATION\nfrom starlette.types import ASGIApp\nfrom starlette.websockets import WebSocket\n\ntry:\n from pydantic.fields import FieldInfo, ModelField\nexcept ImportError: # pragma: nocover\n # TODO: remove when removing support for Pydantic < 1.0.0\n from pydantic import Schema as FieldInfo # type: ignore\n from pydantic.fields import Field as ModelField # type: ignore\n\n\ndef _prepare_response_content(\n res: Any, *, by_alias: bool = True, exclude_unset: bool\n) -> Any:\n if isinstance(res, BaseModel):\n if PYDANTIC_1:\n return res.dict(by_alias=by_alias, exclude_unset=exclude_unset)\n else:\n return res.dict(\n by_alias=by_alias, skip_defaults=exclude_unset\n ) # pragma: nocover\n elif isinstance(res, list):\n return [\n _prepare_response_content(item, exclude_unset=exclude_unset) for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(v, exclude_unset=exclude_unset)\n for k, v in res.items()\n }\n return res\n\n\nasync def serialize_response(\n *,\n field: ModelField = None,\n response_content: Any,\n include: Union[SetIntStr, DictIntStrAny] = None,\n exclude: Union[SetIntStr, DictIntStrAny] = set(),\n by_alias: bool = True,\n exclude_unset: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n response_content = _prepare_response_content(\n response_content, by_alias=by_alias, exclude_unset=exclude_unset\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, ErrorWrapper):\n errors.append(errors_)\n elif isinstance(errors_, list):\n errors.extend(errors_)\n if errors:\n raise ValidationError(errors, field.type_)\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: ModelField = None,\n status_code: int = 200,\n response_class: Type[Response] = JSONResponse,\n response_field: ModelField = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n dependency_overrides_provider: Any = None,\n) -> Callable:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n get_field_info(body_field), params.Form)\n\n async def app(request: Request) -> Response:\n try:\n body = None\n if body_field:\n if is_body_form:\n body = await request.form()\n else:\n body_bytes = await request.body()\n if body_bytes:\n body = await request.json()\n except Exception as e:\n logger.error(f\"Error getting request body: {e}\")\n raise HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n ) from e\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, background_tasks, sub_response, _ = solved_result\n if errors:\n raise RequestValidationError(errors, body=body)\n else:\n raw_response = await run_endpoint_function(\n dependant=dependant, values=values, is_coroutine=is_coroutine\n )\n\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = background_tasks\n return raw_response\n response_data = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n is_coroutine=is_coroutine,\n )\n response = response_class(\n content=response_data,\n status_code=status_code,\n background=background_tasks,\n )\n response.headers.raw.extend(sub_response.headers.raw)\n if sub_response.status_code:\n response.status_code = sub_response.status_code\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant, dependency_overrides_provider: Any = None\n) -> Callable:\n async def app(websocket: WebSocket) -> None:\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n values, errors, _, _2, _3 = solved_result\n if errors:\n await websocket.close(code=WS_1008_POLICY_VIOLATION)\n raise WebSocketRequestValidationError(errors)\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n name: str = None,\n dependency_overrides_provider: Any = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependant = get_dependant(path=path, call=self.endpoint)\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n )\n )\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n name: str = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Optional[Type[Response]] = None,\n dependency_overrides_provider: Any = None,\n callbacks: Optional[List[\"APIRoute\"]] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods = set([method.upper() for method in methods])\n self.unique_id = generate_operation_id_for_path(\n name=self.name, path=self.path_format, method=list(methods)[0]\n )\n self.response_model = response_model\n if self.response_model:\n assert (\n status_code not in STATUS_CODES_WITH_NO_BODY\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_response_field(\n name=response_name, type_=self.response_model\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will be always created.\n self.secure_cloned_response_field: Optional[\n ModelField\n ] = create_cloned_field(self.response_field)\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.status_code = status_code\n self.tags = tags or []\n if dependencies:\n self.dependencies = list(dependencies)\n else:\n self.dependencies = []\n self.summary = summary\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0]\n self.response_description = response_description\n self.responses = responses or {}\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert (\n additional_status_code not in STATUS_CODES_WITH_NO_BODY\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_response_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n\n assert callable(endpoint), f\"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self.body_field = get_body_field(\n dependant=self.dependant, name=self.unique_id)\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class or JSONResponse,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n\n\nclass APIRouter(routing.Router):\n def __init__(\n self,\n routes: List[routing.BaseRoute] = None,\n redirect_slashes: bool = True,\n default: ASGIApp = None,\n dependency_overrides_provider: Any = None,\n route_class: Type[APIRoute] = APIRoute,\n default_response_class: Type[Response] = None,\n on_startup: Sequence[Callable] = None,\n on_shutdown: Sequence[Callable] = None,\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n )\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: List[APIRoute] = None,\n ) -> None:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n route_class = route_class_override or self.route_class\n route = route_class(\n path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=callbacks,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n methods: List[str] = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n\n def decorator(func: Callable) -> Callable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self, path: str, endpoint: Callable, name: str = None\n ) -> None:\n route = APIWebSocketRoute(path, endpoint=endpoint, name=name)\n self.routes.append(route)\n\n def websocket(self, path: str, name: str = None) -> Callable:\n def decorator(func: Callable) -> Callable:\n self.add_api_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: \"APIRouter\",\n *,\n prefix: str = \"\",\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n default_response_class: Optional[Type[Response]] = None,\n ) -> None:\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\")\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise Exception(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=(route.tags or []) + (tags or []),\n dependencies=list(dependencies or [])\n + list(route.dependencies or []),\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n include_in_schema=route.include_in_schema,\n response_class=route.response_class or default_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=route.callbacks,\n )\n elif isinstance(route, routing.Route):\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=list(route.methods or []),\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n self.add_api_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n\n def get(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def put(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def post(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def delete(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def options(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def head(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def patch(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n\n def trace(\n self,\n path: str,\n *,\n response_model: Type[Any] = None,\n status_code: int = 200,\n tags: List[str] = None,\n dependencies: Sequence[params.Depends] = None,\n summary: str = None,\n description: str = None,\n response_description: str = \"Successful Response\",\n responses: Dict[Union[int, str], Dict[str, Any]] = None,\n deprecated: bool = None,\n operation_id: str = None,\n response_model_include: Union[SetIntStr, DictIntStrAny] = None,\n response_model_exclude: Union[SetIntStr, DictIntStrAny] = set(),\n response_model_by_alias: bool = True,\n response_model_skip_defaults: bool = None,\n response_model_exclude_unset: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = None,\n name: str = None,\n callbacks: List[APIRoute] = None,\n ) -> Callable:\n if response_model_skip_defaults is not None:\n warning_response_model_skip_defaults_deprecated() # pragma: nocover\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags or [],\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses or {},\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=bool(\n response_model_exclude_unset or response_model_skip_defaults\n ),\n include_in_schema=include_in_schema,\n response_class=response_class or self.default_response_class,\n name=name,\n callbacks=callbacks,\n )\n"},"new_filtered_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(\n response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response],\n DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(\n body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\n \"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(\n content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(\n solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(\n path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(\n self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(\n response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(\n name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int,\n str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(\n path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(\n depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\n \"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP HEAD operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.head(\"/items/\", status_code=204)\n def get_items_headers(response: Response):\n response.headers[\"X-Cat-Dog\"] = \"Alone in the world\"\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"HEAD\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def patch(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PATCH operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.patch(\"/items/\")\n def update_item(item: Item):\n return {\"message\": \"Item updated in place\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PATCH\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def trace(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP TRACE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.trace(\"/items/{item_id}\")\n def trace_item(item_id: str):\n return None\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"TRACE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n @deprecated(\n \"\"\"\n on_event is deprecated, use lifespan event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n )\n def on_event(\n self,\n event_type: Annotated[\n str,\n Doc(\n \"\"\"\n The type of event. `startup` or `shutdown`.\n \"\"\"\n ),\n ],\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add an event handler for the router.\n\n `on_event` is deprecated, use `lifespan` event handlers instead.\n\n Read more about it in the\n [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_event_handler(event_type, func)\n return func\n\n return decorator\n"},"new_complete_context":{"kind":"string","value":"import asyncio\nimport dataclasses\nimport email.message\nimport inspect\nimport json\nfrom contextlib import AsyncExitStack, asynccontextmanager\nfrom enum import Enum, IntEnum\nfrom typing import (\n Any,\n AsyncIterator,\n Callable,\n Coroutine,\n Dict,\n List,\n Mapping,\n Optional,\n Sequence,\n Set,\n Tuple,\n Type,\n Union,\n)\n\nfrom fastapi import params\nfrom fastapi._compat import (\n ModelField,\n Undefined,\n _get_model_config,\n _model_dump,\n _normalize_errors,\n lenient_issubclass,\n)\nfrom fastapi.datastructures import Default, DefaultPlaceholder\nfrom fastapi.dependencies.models import Dependant\nfrom fastapi.dependencies.utils import (\n _should_embed_body_fields,\n get_body_field,\n get_dependant,\n get_flat_dependant,\n get_parameterless_sub_dependant,\n get_typed_return_annotation,\n solve_dependencies,\n)\nfrom fastapi.encoders import jsonable_encoder\nfrom fastapi.exceptions import (\n FastAPIError,\n RequestValidationError,\n ResponseValidationError,\n WebSocketRequestValidationError,\n)\nfrom fastapi.types import DecoratedCallable, IncEx\nfrom fastapi.utils import (\n create_cloned_field,\n create_model_field,\n generate_unique_id,\n get_value_or_default,\n is_body_allowed_for_status_code,\n)\nfrom pydantic import BaseModel\nfrom starlette import routing\nfrom starlette.concurrency import run_in_threadpool\nfrom starlette.exceptions import HTTPException\nfrom starlette.requests import Request\nfrom starlette.responses import JSONResponse, Response\nfrom starlette.routing import (\n BaseRoute,\n Match,\n compile_path,\n get_name,\n request_response,\n websocket_session,\n)\nfrom starlette.routing import Mount as Mount # noqa\nfrom starlette.types import AppType, ASGIApp, Lifespan, Scope\nfrom starlette.websockets import WebSocket\nfrom typing_extensions import Annotated, Doc, deprecated\n\n\ndef _prepare_response_content(\n res: Any,\n *,\n exclude_unset: bool,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n) -> Any:\n if isinstance(res, BaseModel):\n read_with_orm_mode = getattr(_get_model_config(res), \"read_with_orm_mode\", None)\n if read_with_orm_mode:\n # Let from_orm extract the data from this model instead of converting\n # it now to a dict.\n # Otherwise, there's no way to extract lazy data that requires attribute\n # access instead of dict iteration, e.g. lazy relationships.\n return res\n return _model_dump(\n res,\n by_alias=True,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n elif isinstance(res, list):\n return [\n _prepare_response_content(\n item,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for item in res\n ]\n elif isinstance(res, dict):\n return {\n k: _prepare_response_content(\n v,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n for k, v in res.items()\n }\n elif dataclasses.is_dataclass(res):\n return dataclasses.asdict(res)\n return res\n\n\ndef _merge_lifespan_context(\n original_context: Lifespan[Any], nested_context: Lifespan[Any]\n) -> Lifespan[Any]:\n @asynccontextmanager\n async def merged_lifespan(\n app: AppType,\n ) -> AsyncIterator[Optional[Mapping[str, Any]]]:\n async with original_context(app) as maybe_original_state:\n async with nested_context(app) as maybe_nested_state:\n if maybe_nested_state is None and maybe_original_state is None:\n yield None # old ASGI compatibility\n else:\n yield {**(maybe_nested_state or {}), **(maybe_original_state or {})}\n\n return merged_lifespan # type: ignore[return-value]\n\n\nasync def serialize_response(\n *,\n field: Optional[ModelField] = None,\n response_content: Any,\n include: Optional[IncEx] = None,\n exclude: Optional[IncEx] = None,\n by_alias: bool = True,\n exclude_unset: bool = False,\n exclude_defaults: bool = False,\n exclude_none: bool = False,\n is_coroutine: bool = True,\n) -> Any:\n if field:\n errors = []\n if not hasattr(field, \"serialize\"):\n # pydantic v1\n response_content = _prepare_response_content(\n response_content,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n if is_coroutine:\n value, errors_ = field.validate(response_content, {}, loc=(\"response\",))\n else:\n value, errors_ = await run_in_threadpool(\n field.validate, response_content, {}, loc=(\"response\",)\n )\n if isinstance(errors_, list):\n errors.extend(errors_)\n elif errors_:\n errors.append(errors_)\n if errors:\n raise ResponseValidationError(\n errors=_normalize_errors(errors), body=response_content\n )\n\n if hasattr(field, \"serialize\"):\n return field.serialize(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n\n return jsonable_encoder(\n value,\n include=include,\n exclude=exclude,\n by_alias=by_alias,\n exclude_unset=exclude_unset,\n exclude_defaults=exclude_defaults,\n exclude_none=exclude_none,\n )\n else:\n return jsonable_encoder(response_content)\n\n\nasync def run_endpoint_function(\n *, dependant: Dependant, values: Dict[str, Any], is_coroutine: bool\n) -> Any:\n # Only called by get_request_handler. Has been split into its own function to\n # facilitate profiling endpoints, since inner functions are harder to profile.\n assert dependant.call is not None, \"dependant.call must be a function\"\n\n if is_coroutine:\n return await dependant.call(**values)\n else:\n return await run_in_threadpool(dependant.call, **values)\n\n\ndef get_request_handler(\n dependant: Dependant,\n body_field: Optional[ModelField] = None,\n status_code: Optional[int] = None,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(JSONResponse),\n response_field: Optional[ModelField] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n assert dependant.call is not None, \"dependant.call must be a function\"\n is_coroutine = asyncio.iscoroutinefunction(dependant.call)\n is_body_form = body_field and isinstance(body_field.field_info, params.Form)\n if isinstance(response_class, DefaultPlaceholder):\n actual_response_class: Type[Response] = response_class.value\n else:\n actual_response_class = response_class\n\n async def app(request: Request) -> Response:\n response: Union[Response, None] = None\n async with AsyncExitStack() as file_stack:\n try:\n body: Any = None\n if body_field:\n if is_body_form:\n body = await request.form()\n file_stack.push_async_callback(body.close)\n else:\n body_bytes = await request.body()\n if body_bytes:\n json_body: Any = Undefined\n content_type_value = request.headers.get(\"content-type\")\n if not content_type_value:\n json_body = await request.json()\n else:\n message = email.message.Message()\n message[\"content-type\"] = content_type_value\n if message.get_content_maintype() == \"application\":\n subtype = message.get_content_subtype()\n if subtype == \"json\" or subtype.endswith(\"+json\"):\n json_body = await request.json()\n if json_body != Undefined:\n body = json_body\n else:\n body = body_bytes\n except json.JSONDecodeError as e:\n validation_error = RequestValidationError(\n [\n {\n \"type\": \"json_invalid\",\n \"loc\": (\"body\", e.pos),\n \"msg\": \"JSON decode error\",\n \"input\": {},\n \"ctx\": {\"error\": e.msg},\n }\n ],\n body=e.doc,\n )\n raise validation_error from e\n except HTTPException:\n # If a middleware raises an HTTPException, it should be raised again\n raise\n except Exception as e:\n http_error = HTTPException(\n status_code=400, detail=\"There was an error parsing the body\"\n )\n raise http_error from e\n errors: List[Any] = []\n async with AsyncExitStack() as async_exit_stack:\n solved_result = await solve_dependencies(\n request=request,\n dependant=dependant,\n body=body,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n errors = solved_result.errors\n if not errors:\n raw_response = await run_endpoint_function(\n dependant=dependant,\n values=solved_result.values,\n is_coroutine=is_coroutine,\n )\n if isinstance(raw_response, Response):\n if raw_response.background is None:\n raw_response.background = solved_result.background_tasks\n response = raw_response\n else:\n response_args: Dict[str, Any] = {\n \"background\": solved_result.background_tasks\n }\n # If status_code was set, use it, otherwise use the default from the\n # response class, in the case of redirect it's 307\n current_status_code = (\n status_code\n if status_code\n else solved_result.response.status_code\n )\n if current_status_code is not None:\n response_args[\"status_code\"] = current_status_code\n if solved_result.response.status_code:\n response_args[\"status_code\"] = (\n solved_result.response.status_code\n )\n content = await serialize_response(\n field=response_field,\n response_content=raw_response,\n include=response_model_include,\n exclude=response_model_exclude,\n by_alias=response_model_by_alias,\n exclude_unset=response_model_exclude_unset,\n exclude_defaults=response_model_exclude_defaults,\n exclude_none=response_model_exclude_none,\n is_coroutine=is_coroutine,\n )\n response = actual_response_class(content, **response_args)\n if not is_body_allowed_for_status_code(response.status_code):\n response.body = b\"\"\n response.headers.raw.extend(solved_result.response.headers.raw)\n if errors:\n validation_error = RequestValidationError(\n _normalize_errors(errors), body=body\n )\n raise validation_error\n if response is None:\n raise FastAPIError(\n \"No response object was returned. There's a high chance that the \"\n \"application code is raising an exception and a dependency with yield \"\n \"has a block with a bare except, or a block with except Exception, \"\n \"and is not raising the exception again. Read more about it in the \"\n \"docs: https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-with-yield/#dependencies-with-yield-and-except\"\n )\n return response\n\n return app\n\n\ndef get_websocket_app(\n dependant: Dependant,\n dependency_overrides_provider: Optional[Any] = None,\n embed_body_fields: bool = False,\n) -> Callable[[WebSocket], Coroutine[Any, Any, Any]]:\n async def app(websocket: WebSocket) -> None:\n async with AsyncExitStack() as async_exit_stack:\n # TODO: remove this scope later, after a few releases\n # This scope fastapi_astack is no longer used by FastAPI, kept for\n # compatibility, just in case\n websocket.scope[\"fastapi_astack\"] = async_exit_stack\n solved_result = await solve_dependencies(\n request=websocket,\n dependant=dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n async_exit_stack=async_exit_stack,\n embed_body_fields=embed_body_fields,\n )\n if solved_result.errors:\n raise WebSocketRequestValidationError(\n _normalize_errors(solved_result.errors)\n )\n assert dependant.call is not None, \"dependant.call must be a function\"\n await dependant.call(**solved_result.values)\n\n return app\n\n\nclass APIWebSocketRoute(routing.WebSocketRoute):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n name: Optional[str] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n dependency_overrides_provider: Optional[Any] = None,\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n self.name = get_name(endpoint) if name is None else name\n self.dependencies = list(dependencies or [])\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.app = websocket_session(\n get_websocket_app(\n dependant=self.dependant,\n dependency_overrides_provider=dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRoute(routing.Route):\n def __init__(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n name: Optional[str] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n dependency_overrides_provider: Optional[Any] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[\"APIRoute\"], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n self.path = path\n self.endpoint = endpoint\n if isinstance(response_model, DefaultPlaceholder):\n return_annotation = get_typed_return_annotation(endpoint)\n if lenient_issubclass(return_annotation, Response):\n response_model = None\n else:\n response_model = return_annotation\n self.response_model = response_model\n self.summary = summary\n self.response_description = response_description\n self.deprecated = deprecated\n self.operation_id = operation_id\n self.response_model_include = response_model_include\n self.response_model_exclude = response_model_exclude\n self.response_model_by_alias = response_model_by_alias\n self.response_model_exclude_unset = response_model_exclude_unset\n self.response_model_exclude_defaults = response_model_exclude_defaults\n self.response_model_exclude_none = response_model_exclude_none\n self.include_in_schema = include_in_schema\n self.response_class = response_class\n self.dependency_overrides_provider = dependency_overrides_provider\n self.callbacks = callbacks\n self.openapi_extra = openapi_extra\n self.generate_unique_id_function = generate_unique_id_function\n self.tags = tags or []\n self.responses = responses or {}\n self.name = get_name(endpoint) if name is None else name\n self.path_regex, self.path_format, self.param_convertors = compile_path(path)\n if methods is None:\n methods = [\"GET\"]\n self.methods: Set[str] = {method.upper() for method in methods}\n if isinstance(generate_unique_id_function, DefaultPlaceholder):\n current_generate_unique_id: Callable[[APIRoute], str] = (\n generate_unique_id_function.value\n )\n else:\n current_generate_unique_id = generate_unique_id_function\n self.unique_id = self.operation_id or current_generate_unique_id(self)\n # normalize enums e.g. http.HTTPStatus\n if isinstance(status_code, IntEnum):\n status_code = int(status_code)\n self.status_code = status_code\n if self.response_model:\n assert is_body_allowed_for_status_code(\n status_code\n ), f\"Status code {status_code} must not have a response body\"\n response_name = \"Response_\" + self.unique_id\n self.response_field = create_model_field(\n name=response_name,\n type_=self.response_model,\n mode=\"serialization\",\n )\n # Create a clone of the field, so that a Pydantic submodel is not returned\n # as is just because it's an instance of a subclass of a more limited class\n # e.g. UserInDB (containing hashed_password) could be a subclass of User\n # that doesn't have the hashed_password. But because it's a subclass, it\n # would pass the validation and be returned as is.\n # By being a new field, no inheritance will be passed as is. A new model\n # will always be created.\n # TODO: remove when deprecating Pydantic v1\n self.secure_cloned_response_field: Optional[ModelField] = (\n create_cloned_field(self.response_field)\n )\n else:\n self.response_field = None # type: ignore\n self.secure_cloned_response_field = None\n self.dependencies = list(dependencies or [])\n self.description = description or inspect.cleandoc(self.endpoint.__doc__ or \"\")\n # if a \"form feed\" character (page break) is found in the description text,\n # truncate description text to the content preceding the first \"form feed\"\n self.description = self.description.split(\"\\f\")[0].strip()\n response_fields = {}\n for additional_status_code, response in self.responses.items():\n assert isinstance(response, dict), \"An additional response must be a dict\"\n model = response.get(\"model\")\n if model:\n assert is_body_allowed_for_status_code(\n additional_status_code\n ), f\"Status code {additional_status_code} must not have a response body\"\n response_name = f\"Response_{additional_status_code}_{self.unique_id}\"\n response_field = create_model_field(name=response_name, type_=model)\n response_fields[additional_status_code] = response_field\n if response_fields:\n self.response_fields: Dict[Union[int, str], ModelField] = response_fields\n else:\n self.response_fields = {}\n\n assert callable(endpoint), \"An endpoint must be a callable\"\n self.dependant = get_dependant(path=self.path_format, call=self.endpoint)\n for depends in self.dependencies[::-1]:\n self.dependant.dependencies.insert(\n 0,\n get_parameterless_sub_dependant(depends=depends, path=self.path_format),\n )\n self._flat_dependant = get_flat_dependant(self.dependant)\n self._embed_body_fields = _should_embed_body_fields(\n self._flat_dependant.body_params\n )\n self.body_field = get_body_field(\n flat_dependant=self._flat_dependant,\n name=self.unique_id,\n embed_body_fields=self._embed_body_fields,\n )\n self.app = request_response(self.get_route_handler())\n\n def get_route_handler(self) -> Callable[[Request], Coroutine[Any, Any, Response]]:\n return get_request_handler(\n dependant=self.dependant,\n body_field=self.body_field,\n status_code=self.status_code,\n response_class=self.response_class,\n response_field=self.secure_cloned_response_field,\n response_model_include=self.response_model_include,\n response_model_exclude=self.response_model_exclude,\n response_model_by_alias=self.response_model_by_alias,\n response_model_exclude_unset=self.response_model_exclude_unset,\n response_model_exclude_defaults=self.response_model_exclude_defaults,\n response_model_exclude_none=self.response_model_exclude_none,\n dependency_overrides_provider=self.dependency_overrides_provider,\n embed_body_fields=self._embed_body_fields,\n )\n\n def matches(self, scope: Scope) -> Tuple[Match, Scope]:\n match, child_scope = super().matches(scope)\n if match != Match.NONE:\n child_scope[\"route\"] = self\n return match, child_scope\n\n\nclass APIRouter(routing.Router):\n \"\"\"\n `APIRouter` class, used to group *path operations*, for example to structure\n an app in multiple files. It would then be included in the `FastAPI` app, or\n in another `APIRouter` (ultimately included in the app).\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n\n @router.get(\"/users/\", tags=[\"users\"])\n async def read_users():\n return [{\"username\": \"Rick\"}, {\"username\": \"Morty\"}]\n\n\n app.include_router(router)\n ```\n \"\"\"\n\n def __init__(\n self,\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n routes: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n **Note**: you probably shouldn't use this parameter, it is inherited\n from Starlette and supported for compatibility.\n\n ---\n\n A list of routes to serve incoming HTTP and WebSocket requests.\n \"\"\"\n ),\n deprecated(\n \"\"\"\n You normally wouldn't use this parameter with FastAPI, it is inherited\n from Starlette and supported for compatibility.\n\n In FastAPI, you normally would use the *path operation methods*,\n like `router.get()`, `router.post()`, etc.\n \"\"\"\n ),\n ] = None,\n redirect_slashes: Annotated[\n bool,\n Doc(\n \"\"\"\n Whether to detect and redirect slashes in URLs when the client doesn't\n use the same format.\n \"\"\"\n ),\n ] = True,\n default: Annotated[\n Optional[ASGIApp],\n Doc(\n \"\"\"\n Default function handler for this router. Used to handle\n 404 Not Found errors.\n \"\"\"\n ),\n ] = None,\n dependency_overrides_provider: Annotated[\n Optional[Any],\n Doc(\n \"\"\"\n Only used internally by FastAPI to handle dependency overrides.\n\n You shouldn't need to use it. It normally points to the `FastAPI` app\n object.\n \"\"\"\n ),\n ] = None,\n route_class: Annotated[\n Type[APIRoute],\n Doc(\n \"\"\"\n Custom route (*path operation*) class to be used by this router.\n\n Read more about it in the\n [FastAPI docs for Custom Request and APIRoute class](https://fastapi.tiangolo.com/how-to/custom-request-and-route/#custom-apiroute-class-in-a-router).\n \"\"\"\n ),\n ] = APIRoute,\n on_startup: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of startup event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n on_shutdown: Annotated[\n Optional[Sequence[Callable[[], Any]]],\n Doc(\n \"\"\"\n A list of shutdown event handler functions.\n\n You should instead use the `lifespan` handlers.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n # the generic to Lifespan[AppType] is the type of the top level application\n # which the router cannot know statically, so we use typing.Any\n lifespan: Annotated[\n Optional[Lifespan[Any]],\n Doc(\n \"\"\"\n A `Lifespan` context manager handler. This replaces `startup` and\n `shutdown` functions with a single context manager.\n\n Read more in the\n [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n To include (or not) all the *path operations* in this router in the\n generated OpenAPI.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n super().__init__(\n routes=routes,\n redirect_slashes=redirect_slashes,\n default=default,\n on_startup=on_startup,\n on_shutdown=on_shutdown,\n lifespan=lifespan,\n )\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n self.prefix = prefix\n self.tags: List[Union[str, Enum]] = tags or []\n self.dependencies = list(dependencies or [])\n self.deprecated = deprecated\n self.include_in_schema = include_in_schema\n self.responses = responses or {}\n self.callbacks = callbacks or []\n self.dependency_overrides_provider = dependency_overrides_provider\n self.route_class = route_class\n self.default_response_class = default_response_class\n self.generate_unique_id_function = generate_unique_id_function\n\n def route(\n self,\n path: str,\n methods: Optional[List[str]] = None,\n name: Optional[str] = None,\n include_in_schema: bool = True,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_route(\n path,\n func,\n methods=methods,\n name=name,\n include_in_schema=include_in_schema,\n )\n return func\n\n return decorator\n\n def add_api_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[Union[Set[str], List[str]]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Union[Type[Response], DefaultPlaceholder] = Default(\n JSONResponse\n ),\n name: Optional[str] = None,\n route_class_override: Optional[Type[APIRoute]] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Union[\n Callable[[APIRoute], str], DefaultPlaceholder\n ] = Default(generate_unique_id),\n ) -> None:\n route_class = route_class_override or self.route_class\n responses = responses or {}\n combined_responses = {**self.responses, **responses}\n current_response_class = get_value_or_default(\n response_class, self.default_response_class\n )\n current_tags = self.tags.copy()\n if tags:\n current_tags.extend(tags)\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n current_callbacks = self.callbacks.copy()\n if callbacks:\n current_callbacks.extend(callbacks)\n current_generate_unique_id = get_value_or_default(\n generate_unique_id_function, self.generate_unique_id_function\n )\n route = route_class(\n self.prefix + path,\n endpoint=endpoint,\n response_model=response_model,\n status_code=status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=combined_responses,\n deprecated=deprecated or self.deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema and self.include_in_schema,\n response_class=current_response_class,\n name=name,\n dependency_overrides_provider=self.dependency_overrides_provider,\n callbacks=current_callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n self.routes.append(route)\n\n def api_route(\n self,\n path: str,\n *,\n response_model: Any = Default(None),\n status_code: Optional[int] = None,\n tags: Optional[List[Union[str, Enum]]] = None,\n dependencies: Optional[Sequence[params.Depends]] = None,\n summary: Optional[str] = None,\n description: Optional[str] = None,\n response_description: str = \"Successful Response\",\n responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,\n deprecated: Optional[bool] = None,\n methods: Optional[List[str]] = None,\n operation_id: Optional[str] = None,\n response_model_include: Optional[IncEx] = None,\n response_model_exclude: Optional[IncEx] = None,\n response_model_by_alias: bool = True,\n response_model_exclude_unset: bool = False,\n response_model_exclude_defaults: bool = False,\n response_model_exclude_none: bool = False,\n include_in_schema: bool = True,\n response_class: Type[Response] = Default(JSONResponse),\n name: Optional[str] = None,\n callbacks: Optional[List[BaseRoute]] = None,\n openapi_extra: Optional[Dict[str, Any]] = None,\n generate_unique_id_function: Callable[[APIRoute], str] = Default(\n generate_unique_id\n ),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_route(\n path,\n func,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=methods,\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n return func\n\n return decorator\n\n def add_api_websocket_route(\n self,\n path: str,\n endpoint: Callable[..., Any],\n name: Optional[str] = None,\n *,\n dependencies: Optional[Sequence[params.Depends]] = None,\n ) -> None:\n current_dependencies = self.dependencies.copy()\n if dependencies:\n current_dependencies.extend(dependencies)\n\n route = APIWebSocketRoute(\n self.prefix + path,\n endpoint=endpoint,\n name=name,\n dependencies=current_dependencies,\n dependency_overrides_provider=self.dependency_overrides_provider,\n )\n self.routes.append(route)\n\n def websocket(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n WebSocket path.\n \"\"\"\n ),\n ],\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A name for the WebSocket. Only used internally.\n \"\"\"\n ),\n ] = None,\n *,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be used for this\n WebSocket.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n \"\"\"\n ),\n ] = None,\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Decorate a WebSocket function.\n\n Read more about it in the\n [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).\n\n **Example**\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI, WebSocket\n\n app = FastAPI()\n router = APIRouter()\n\n @router.websocket(\"/ws\")\n async def websocket_endpoint(websocket: WebSocket):\n await websocket.accept()\n while True:\n data = await websocket.receive_text()\n await websocket.send_text(f\"Message text was: {data}\")\n\n app.include_router(router)\n ```\n \"\"\"\n\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_api_websocket_route(\n path, func, name=name, dependencies=dependencies\n )\n return func\n\n return decorator\n\n def websocket_route(\n self, path: str, name: Union[str, None] = None\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n def decorator(func: DecoratedCallable) -> DecoratedCallable:\n self.add_websocket_route(path, func, name=name)\n return func\n\n return decorator\n\n def include_router(\n self,\n router: Annotated[\"APIRouter\", Doc(\"The `APIRouter` to include.\")],\n *,\n prefix: Annotated[str, Doc(\"An optional path prefix for the router.\")] = \"\",\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to all the *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to all the\n *path operations* in this router.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n default_response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n The default response class to be used.\n\n Read more in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses to be shown in OpenAPI.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).\n\n And in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n OpenAPI callbacks that should apply to all *path operations* in this\n router.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark all *path operations* in this router as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include (or not) all the *path operations* in this router in the\n generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = True,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> None:\n \"\"\"\n Include another `APIRouter` in the same current `APIRouter`.\n\n Read more about it in the\n [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n internal_router = APIRouter()\n users_router = APIRouter()\n\n @users_router.get(\"/users/\")\n def read_users():\n return [{\"name\": \"Rick\"}, {\"name\": \"Morty\"}]\n\n internal_router.include_router(users_router)\n app.include_router(internal_router)\n ```\n \"\"\"\n if prefix:\n assert prefix.startswith(\"/\"), \"A path prefix must start with '/'\"\n assert not prefix.endswith(\n \"/\"\n ), \"A path prefix must not end with '/', as the routes will start with '/'\"\n else:\n for r in router.routes:\n path = getattr(r, \"path\") # noqa: B009\n name = getattr(r, \"name\", \"unknown\")\n if path is not None and not path:\n raise FastAPIError(\n f\"Prefix and path cannot be both empty (path operation: {name})\"\n )\n if responses is None:\n responses = {}\n for route in router.routes:\n if isinstance(route, APIRoute):\n combined_responses = {**responses, **route.responses}\n use_response_class = get_value_or_default(\n route.response_class,\n router.default_response_class,\n default_response_class,\n self.default_response_class,\n )\n current_tags = []\n if tags:\n current_tags.extend(tags)\n if route.tags:\n current_tags.extend(route.tags)\n current_dependencies: List[params.Depends] = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n current_callbacks = []\n if callbacks:\n current_callbacks.extend(callbacks)\n if route.callbacks:\n current_callbacks.extend(route.callbacks)\n current_generate_unique_id = get_value_or_default(\n route.generate_unique_id_function,\n router.generate_unique_id_function,\n generate_unique_id_function,\n self.generate_unique_id_function,\n )\n self.add_api_route(\n prefix + route.path,\n route.endpoint,\n response_model=route.response_model,\n status_code=route.status_code,\n tags=current_tags,\n dependencies=current_dependencies,\n summary=route.summary,\n description=route.description,\n response_description=route.response_description,\n responses=combined_responses,\n deprecated=route.deprecated or deprecated or self.deprecated,\n methods=route.methods,\n operation_id=route.operation_id,\n response_model_include=route.response_model_include,\n response_model_exclude=route.response_model_exclude,\n response_model_by_alias=route.response_model_by_alias,\n response_model_exclude_unset=route.response_model_exclude_unset,\n response_model_exclude_defaults=route.response_model_exclude_defaults,\n response_model_exclude_none=route.response_model_exclude_none,\n include_in_schema=route.include_in_schema\n and self.include_in_schema\n and include_in_schema,\n response_class=use_response_class,\n name=route.name,\n route_class_override=type(route),\n callbacks=current_callbacks,\n openapi_extra=route.openapi_extra,\n generate_unique_id_function=current_generate_unique_id,\n )\n elif isinstance(route, routing.Route):\n methods = list(route.methods or [])\n self.add_route(\n prefix + route.path,\n route.endpoint,\n methods=methods,\n include_in_schema=route.include_in_schema,\n name=route.name,\n )\n elif isinstance(route, APIWebSocketRoute):\n current_dependencies = []\n if dependencies:\n current_dependencies.extend(dependencies)\n if route.dependencies:\n current_dependencies.extend(route.dependencies)\n self.add_api_websocket_route(\n prefix + route.path,\n route.endpoint,\n dependencies=current_dependencies,\n name=route.name,\n )\n elif isinstance(route, routing.WebSocketRoute):\n self.add_websocket_route(\n prefix + route.path, route.endpoint, name=route.name\n )\n for handler in router.on_startup:\n self.add_event_handler(\"startup\", handler)\n for handler in router.on_shutdown:\n self.add_event_handler(\"shutdown\", handler)\n self.lifespan_context = _merge_lifespan_context(\n self.lifespan_context,\n router.lifespan_context,\n )\n\n def get(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP GET operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.get(\"/items/\")\n def read_items():\n return [{\"name\": \"Empanada\"}, {\"name\": \"Arepa\"}]\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"GET\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def put(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP PUT operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.put(\"/items/{item_id}\")\n def replace_item(item_id: str, item: Item):\n return {\"message\": \"Item replaced\", \"id\": item_id}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"PUT\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def post(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP POST operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n from pydantic import BaseModel\n\n class Item(BaseModel):\n name: str\n description: str | None = None\n\n app = FastAPI()\n router = APIRouter()\n\n @router.post(\"/items/\")\n def create_item(item: Item):\n return {\"message\": \"Item created\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"POST\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def delete(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP DELETE operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.delete(\"/items/{item_id}\")\n def delete_item(item_id: str):\n return {\"message\": \"Item deleted\"}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"DELETE\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def options(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"\n List of *path operations* that will be used as OpenAPI callbacks.\n\n This is only for OpenAPI documentation, the callbacks won't be used\n directly.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).\n \"\"\"\n ),\n ] = None,\n openapi_extra: Annotated[\n Optional[Dict[str, Any]],\n Doc(\n \"\"\"\n Extra metadata to be included in the OpenAPI schema for this *path\n operation*.\n\n Read more about it in the\n [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).\n \"\"\"\n ),\n ] = None,\n generate_unique_id_function: Annotated[\n Callable[[APIRoute], str],\n Doc(\n \"\"\"\n Customize the function used to generate unique IDs for the *path\n operations* shown in the generated OpenAPI.\n\n This is particularly useful when automatically generating clients or\n SDKs for your API.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = Default(generate_unique_id),\n ) -> Callable[[DecoratedCallable], DecoratedCallable]:\n \"\"\"\n Add a *path operation* using an HTTP OPTIONS operation.\n\n ## Example\n\n ```python\n from fastapi import APIRouter, FastAPI\n\n app = FastAPI()\n router = APIRouter()\n\n @router.options(\"/items/\")\n def get_item_options():\n return {\"additions\": [\"Aji\", \"Guacamole\"]}\n\n app.include_router(router)\n ```\n \"\"\"\n return self.api_route(\n path=path,\n response_model=response_model,\n status_code=status_code,\n tags=tags,\n dependencies=dependencies,\n summary=summary,\n description=description,\n response_description=response_description,\n responses=responses,\n deprecated=deprecated,\n methods=[\"OPTIONS\"],\n operation_id=operation_id,\n response_model_include=response_model_include,\n response_model_exclude=response_model_exclude,\n response_model_by_alias=response_model_by_alias,\n response_model_exclude_unset=response_model_exclude_unset,\n response_model_exclude_defaults=response_model_exclude_defaults,\n response_model_exclude_none=response_model_exclude_none,\n include_in_schema=include_in_schema,\n response_class=response_class,\n name=name,\n callbacks=callbacks,\n openapi_extra=openapi_extra,\n generate_unique_id_function=generate_unique_id_function,\n )\n\n def head(\n self,\n path: Annotated[\n str,\n Doc(\n \"\"\"\n The URL path to be used for this *path operation*.\n\n For example, in `http://example.com/items`, the path is `/items`.\n \"\"\"\n ),\n ],\n *,\n response_model: Annotated[\n Any,\n Doc(\n \"\"\"\n The type to use for the response.\n\n It could be any valid Pydantic *field* type. So, it doesn't have to\n be a Pydantic model, it could be other things, like a `list`, `dict`,\n etc.\n\n It will be used for:\n\n * Documentation: the generated OpenAPI (and the UI at `/docs`) will\n show it as the response (JSON Schema).\n * Serialization: you could return an arbitrary object and the\n `response_model` would be used to serialize that object into the\n corresponding JSON.\n * Filtering: the JSON sent to the client will only contain the data\n (fields) defined in the `response_model`. If you returned an object\n that contains an attribute `password` but the `response_model` does\n not include that field, the JSON sent to the client would not have\n that `password`.\n * Validation: whatever you return will be serialized with the\n `response_model`, converting any data as necessary to generate the\n corresponding JSON. But if the data in the object returned is not\n valid, that would mean a violation of the contract with the client,\n so it's an error from the API developer. So, FastAPI will raise an\n error and return a 500 error code (Internal Server Error).\n\n Read more about it in the\n [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).\n \"\"\"\n ),\n ] = Default(None),\n status_code: Annotated[\n Optional[int],\n Doc(\n \"\"\"\n The default status code to be used for the response.\n\n You could override the status code by returning a response directly.\n\n Read more about it in the\n [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).\n \"\"\"\n ),\n ] = None,\n tags: Annotated[\n Optional[List[Union[str, Enum]]],\n Doc(\n \"\"\"\n A list of tags to be applied to the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).\n \"\"\"\n ),\n ] = None,\n dependencies: Annotated[\n Optional[Sequence[params.Depends]],\n Doc(\n \"\"\"\n A list of dependencies (using `Depends()`) to be applied to the\n *path operation*.\n\n Read more about it in the\n [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).\n \"\"\"\n ),\n ] = None,\n summary: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A summary for the *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n description: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n A description for the *path operation*.\n\n If not provided, it will be extracted automatically from the docstring\n of the *path operation function*.\n\n It can contain Markdown.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).\n \"\"\"\n ),\n ] = None,\n response_description: Annotated[\n str,\n Doc(\n \"\"\"\n The description for the default response.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = \"Successful Response\",\n responses: Annotated[\n Optional[Dict[Union[int, str], Dict[str, Any]]],\n Doc(\n \"\"\"\n Additional responses that could be returned by this *path operation*.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n deprecated: Annotated[\n Optional[bool],\n Doc(\n \"\"\"\n Mark this *path operation* as deprecated.\n\n It will be added to the generated OpenAPI (e.g. visible at `/docs`).\n \"\"\"\n ),\n ] = None,\n operation_id: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Custom operation ID to be used by this *path operation*.\n\n By default, it is generated automatically.\n\n If you provide a custom operation ID, you need to make sure it is\n unique for the whole API.\n\n You can customize the\n operation ID generation with the parameter\n `generate_unique_id_function` in the `FastAPI` class.\n\n Read more about it in the\n [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).\n \"\"\"\n ),\n ] = None,\n response_model_include: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to include only certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_exclude: Annotated[\n Optional[IncEx],\n Doc(\n \"\"\"\n Configuration passed to Pydantic to exclude certain fields in the\n response data.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = None,\n response_model_by_alias: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response model\n should be serialized by alias when an alias is used.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).\n \"\"\"\n ),\n ] = True,\n response_model_exclude_unset: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that were not set and\n have their default values. This is different from\n `response_model_exclude_defaults` in that if the fields are set,\n they will be included in the response, even if the value is the same\n as the default.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_defaults: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data\n should have all the fields, including the ones that have the same value\n as the default. This is different from `response_model_exclude_unset`\n in that if the fields are set but contain the same default values,\n they will be excluded from the response.\n\n When `True`, default values are omitted from the response.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).\n \"\"\"\n ),\n ] = False,\n response_model_exclude_none: Annotated[\n bool,\n Doc(\n \"\"\"\n Configuration passed to Pydantic to define if the response data should\n exclude fields set to `None`.\n\n This is much simpler (less smart) than `response_model_exclude_unset`\n and `response_model_exclude_defaults`. You probably want to use one of\n those two instead of this one, as those allow returning `None` values\n when it makes sense.\n\n Read more about it in the\n [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).\n \"\"\"\n ),\n ] = False,\n include_in_schema: Annotated[\n bool,\n Doc(\n \"\"\"\n Include this *path operation* in the generated OpenAPI schema.\n\n This affects the generated OpenAPI (e.g. visible at `/docs`).\n\n Read more about it in the\n [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).\n \"\"\"\n ),\n ] = True,\n response_class: Annotated[\n Type[Response],\n Doc(\n \"\"\"\n Response class to be used for this *path operation*.\n\n This will not be used if you return a response directly.\n\n Read more about it in the\n [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).\n \"\"\"\n ),\n ] = Default(JSONResponse),\n name: Annotated[\n Optional[str],\n Doc(\n \"\"\"\n Name for this *path operation*. Only used internally.\n \"\"\"\n ),\n ] = None,\n callbacks: Annotated[\n Optional[List[BaseRoute]],\n Doc(\n \"\"\"